v10

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

Retrieve a table

Get details of a specific table extracted from the structured sheet. Only available when conversion status is 'completed'.

get/v1/structured-sheets/{structured_sheet_id}/tables/{table_id}

Path parameters

structured_sheet_idstring required

The unique identifier of the structured sheet conversion.

Example:ss_01kfxgjd94fn9stqm42nejb627

The unique identifier of the structured sheet conversion.

table_idstring required

The unique identifier of the table.

Example:tbl_01kfxgjd94fn9stqm45rqr2pnz

The unique identifier of the table.

Response

Successful Response

idstring required

The unique identifier for this table.

object'table' required

The object type, which is always 'table'.

structured_sheet_idstring required

The ID of the structured sheet this table belongs to.

namestring required

Composite table name: {normalized_sheet_name}__{table_name}. Uses lowercase snake_case. Aggregation tables end with '__aggregations'. Two special metadata tables exist per structured sheet: '__deeptable_workbook_metadata' (workbook provenance info) and '__deeptable_table_overview' (summary of all tables). Example: 'staffing__head_count' or 'staffing__head_count__aggregations'.

type'relational' | 'aggregation' | 'tableless' | 'metadata' required

Type of table extracted from a structured sheet.

  • relational: Core data table with dimensional indices
  • aggregation: Precomputed aggregations from Excel (sums, averages, etc.)
  • tableless: Cells not belonging to any table (README cells)
  • metadata: Provenance and metadata tables (workbook info, table overviews)
sheet_namestring required

The original Excel sheet name this table came from.

created_atstring date-time required

The timestamp when this table was created.

Example response

{
  "created_at": "2026-01-15T10:35:00Z",
  "id": "tbl_01kfxgjd94fn9stqm45rqr2pnz",
  "name": "staffing__head_count",
  "object": "table",
  "sheet_name": "Staffing",
  "structured_sheet_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "type": "relational"
}