Skip to content
DeepTable
Get started
API Reference
Structured Sheets

List structured sheets

structured_sheets.list(StructuredSheetListParams**kwargs) -> SyncCursorIDPage[StructuredSheetResponse]
GET/v1/structured-sheets

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

ParametersExpand Collapse
after: Optional[str]

A cursor for pagination. Use the last_id from a previous response to fetch the next page of results.

limit: Optional[int]

Maximum number of results to return per page.

formatint32
maximum100
minimum1
ReturnsExpand Collapse
class StructuredSheetResponse: …

Response representing a structured sheet conversion job.

This is returned from POST (create), GET (retrieve), and list endpoints.

id: str

The unique identifier for this structured sheet conversion.

created_at: datetime

The timestamp when the conversion was started.

formatdate-time
file_id: str

The unique identifier for the source file.

object: Literal["structured_sheet"]

The object type, which is always 'structured_sheet'.

status: Literal["queued", "in_progress", "completed", 2 more]

The current processing status.

One of the following:
"queued"
"in_progress"
"completed"
"failed"
"cancelled"
updated_at: datetime

The timestamp when the conversion was last updated.

formatdate-time
last_error: Optional[LastError]

Error information when processing fails.

code: str

A machine-readable error code.

maxLength64
message: str

A human-readable description of the error.

maxLength1024
sheet_names: Optional[List[str]]

List of sheet names included in this conversion.

table_count: Optional[int]

Number of tables extracted from the workbook. Only present when status is 'completed'.

minimum0

List structured sheets

import os
from deeptable import DeepTable

client = DeepTable(
    api_key=os.environ.get("DEEPTABLE_API_KEY"),  # This is the default and can be omitted
)
page = client.structured_sheets.list()
page = page.data[0]
print(page.id)
{
  "data": [
    {
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "object": "structured_sheet",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "table_count": 6
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627"
}
Returns Examples
{
  "data": [
    {
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "object": "structured_sheet",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "table_count": 6
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627"
}