List structured sheets

GET/v1/structured-sheets

List all structured sheets conversions for the authenticated user. Results are paginated using cursor-based pagination.

Query ParametersExpand Collapse

after: optional string

Unique identifier for a structured sheets conversion.

limit: optional number

Maximum number of results to return per page.

maximum100

minimum1

ReturnsExpand Collapse

data: array of StructuredSheetResponse { id, created_at, file_id, 6 more }

List of structured sheets conversions.

id: string

The unique identifier for this structured sheets conversion.

created_at: string

The timestamp when the conversion was started.

formatdate-time

file_id: string

The unique identifier for the source file.

status: "pending" or "queued" or "in_progress" or 3 more

The current processing status.

Accepts one of the following:

"pending"

"queued"

"in_progress"

"completed"

"failed"

"cancelled"

updated_at: string

The timestamp when the conversion was last updated.

formatdate-time

exports_available: optional array of string

List of export formats available for download (e.g., ['sqlite']).

last_error: optional object { code, message }

Error information when processing fails.

code: string

A machine-readable error code.

maxLength64

message: string

A human-readable description of the error.

maxLength1024

object: optional "structured_sheet"

The object type, which is always 'structured_sheet'.

sheet_names: optional array of string

List of sheet names included in this conversion.

has_more: boolean

Whether there are more results available after this page.

first_id: optional string

Unique identifier for a structured sheets conversion.

last_id: optional string

Unique identifier for a structured sheets conversion.

object: optional "list"

The object type, which is always 'list'.

List structured sheets

curl https://api.deeptable.com/v1/structured-sheets \
    -H "Authorization: Bearer $DEEPTABLE_API_KEY"

{
  "data": [
    {
      "id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "exports_available": [
        "sqlite"
      ],
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "object": "structured_sheet",
      "sheet_names": [
        "Sheet1",
        "Financials"
      ]
    }
  ],
  "has_more": false,
  "first_id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
  "last_id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
  "object": "list"
}

Returns Examples

{
  "data": [
    {
      "id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01abc2def3ghjkmnpqrs4uvwxy",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "exports_available": [
        "sqlite"
      ],
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "object": "structured_sheet",
      "sheet_names": [
        "Sheet1",
        "Financials"
      ]
    }
  ],
  "has_more": false,
  "first_id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
  "last_id": "ss_01abc2def3ghjkmnpqrs4uvwxy",
  "object": "list"
}