Sign in

v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-05141768.5 KB
Structured Sheets

List structured sheets

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

get/v1/structured-sheets

Query parameters

limitinteger

Maximum number of results to return per page.

Example:20

Maximum number of results to return per page.

afterstring nullable

Unique identifier for a structured sheet conversion.

Example:ss_01kfxgjd94fn9stqm42nejb627

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

Response

Successful Response

object'list' required

The object type, which is always 'list'.

first_idstring nullable

Unique identifier for a structured sheet conversion.

last_idstring nullable

Unique identifier for a structured sheet conversion.

has_moreboolean required

Whether there are more results available after this page.

Example response

{
  "data": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "object": "structured_sheet",
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "status": "completed",
      "table_count": 6,
      "updated_at": "2024-01-15T10:35:00Z"
    }
  ],
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "has_more": false,
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "object": "list"
}