# Tables

## List tables in structured sheet

`client.structuredSheets.tables.list(stringstructuredSheetID, TableListParamsquery?, RequestOptionsoptions?): CursorIDPage<TableResponse>`

**get** `/v1/structured-sheets/{structured_sheet_id}/tables`

List all tables extracted from the structured sheet. Only available when conversion status is 'completed'.

### Parameters

- `structuredSheetID: string`

  The unique identifier of the structured sheet conversion.

- `query: TableListParams`

  - `after?: string | null`

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

  - `limit?: number`

    Maximum number of tables to return per page.

### Returns

- `TableResponse`

  Response representing a table extracted from a structured sheet.

  This is returned from GET (retrieve) and list table endpoints.
  Table names use a composite format: {normalized_sheet_name}__{table_name}.

  - `id: string`

    The unique identifier for this table.

  - `created_at: string`

    The timestamp when this table was created.

  - `name: string`

    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'.

  - `object: "table"`

    The object type, which is always 'table'.

    - `"table"`

  - `sheet_name: string`

    The original Excel sheet name this table came from.

  - `structured_sheet_id: string`

    The ID of the structured sheet this table belongs to.

  - `type: "relational" | "aggregation" | "tableless" | "metadata"`

    The type of table (relational, aggregation, tableless, or metadata).

    - `"relational"`

    - `"aggregation"`

    - `"tableless"`

    - `"metadata"`

### Example

```typescript
import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const tableResponse of client.structuredSheets.tables.list(
  'ss_01kfxgjd94fn9stqm42nejb627',
)) {
  console.log(tableResponse.id);
}
```

#### Response

```json
{
  "data": [
    {
      "id": "tbl_01kfxgjd94fn9stqm45rqr2pnz",
      "created_at": "2026-01-15T10:35:00Z",
      "name": "staffing__head_count",
      "object": "table",
      "sheet_name": "Staffing",
      "structured_sheet_id": "ss_01kfxgjd94fn9stqm42nejb627",
      "type": "relational"
    },
    {
      "id": "tbl_02abc2def3ghjkmnpqrs4uvwxz",
      "created_at": "2026-01-15T10:35:00Z",
      "name": "staffing__head_count__aggregations",
      "object": "table",
      "sheet_name": "Staffing",
      "structured_sheet_id": "ss_01kfxgjd94fn9stqm42nejb627",
      "type": "aggregation"
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "tbl_01kfxgjd94fn9stqm45rqr2pnz",
  "last_id": "tbl_02abc2def3ghjkmnpqrs4uvwxz"
}
```

## Retrieve a table

`client.structuredSheets.tables.retrieve(stringtableID, TableRetrieveParamsparams, RequestOptionsoptions?): TableResponse`

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

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

### Parameters

- `tableID: string`

  The unique identifier of the table.

- `params: TableRetrieveParams`

  - `structured_sheet_id: string`

    The unique identifier of the structured sheet conversion.

### Returns

- `TableResponse`

  Response representing a table extracted from a structured sheet.

  This is returned from GET (retrieve) and list table endpoints.
  Table names use a composite format: {normalized_sheet_name}__{table_name}.

  - `id: string`

    The unique identifier for this table.

  - `created_at: string`

    The timestamp when this table was created.

  - `name: string`

    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'.

  - `object: "table"`

    The object type, which is always 'table'.

    - `"table"`

  - `sheet_name: string`

    The original Excel sheet name this table came from.

  - `structured_sheet_id: string`

    The ID of the structured sheet this table belongs to.

  - `type: "relational" | "aggregation" | "tableless" | "metadata"`

    The type of table (relational, aggregation, tableless, or metadata).

    - `"relational"`

    - `"aggregation"`

    - `"tableless"`

    - `"metadata"`

### Example

```typescript
import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const tableResponse = await client.structuredSheets.tables.retrieve(
  'tbl_01kfxgjd94fn9stqm45rqr2pnz',
  { structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627' },
);

console.log(tableResponse.id);
```

#### Response

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

## Download table data

`client.structuredSheets.tables.download(stringtableID, TableDownloadParamsparams, RequestOptionsoptions?): Response`

**get** `/v1/structured-sheets/{structured_sheet_id}/tables/{table_id}/download`

Download the table data in the specified format.

Available formats:

- `parquet`: Apache Parquet columnar format (recommended for data analysis)
- `csv`: Comma-separated values (compatible with any spreadsheet application)

### Parameters

- `tableID: string`

  The unique identifier of the table.

- `params: TableDownloadParams`

  - `structured_sheet_id: string`

    Path param: The unique identifier of the structured sheet conversion.

  - `format: "parquet" | "csv"`

    Query param: The format to download the table data in.

    - `"parquet"`

    - `"csv"`

### Returns

- `unnamed_schema_5 = Response`

### Example

```typescript
import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const response = await client.structuredSheets.tables.download('tbl_01kfxgjd94fn9stqm45rqr2pnz', {
  structured_sheet_id: 'ss_01kfxgjd94fn9stqm42nejb627',
  format: 'parquet',
});

console.log(response);

const content = await response.blob();
console.log(content);
```

## Domain Types

### Table Response

- `TableResponse`

  Response representing a table extracted from a structured sheet.

  This is returned from GET (retrieve) and list table endpoints.
  Table names use a composite format: {normalized_sheet_name}__{table_name}.

  - `id: string`

    The unique identifier for this table.

  - `created_at: string`

    The timestamp when this table was created.

  - `name: string`

    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'.

  - `object: "table"`

    The object type, which is always 'table'.

    - `"table"`

  - `sheet_name: string`

    The original Excel sheet name this table came from.

  - `structured_sheet_id: string`

    The ID of the structured sheet this table belongs to.

  - `type: "relational" | "aggregation" | "tableless" | "metadata"`

    The type of table (relational, aggregation, tableless, or metadata).

    - `"relational"`

    - `"aggregation"`

    - `"tableless"`

    - `"metadata"`