Skip to content
DeepTable
Get started
API Reference
Structured Sheets
Tables

List tables in structured sheet

client.StructuredSheets.Tables.List(ctx, structuredSheetID, query) (*CursorIDPage[TableResponse], error)
GET/v1/structured-sheets/{structured_sheet_id}/tables

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

ParametersExpand Collapse
structuredSheetID string

The unique identifier of the structured sheet conversion.

query StructuredSheetTableListParams
After param.Field[string]optional

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

Limit param.Field[int64]optional

Maximum number of tables to return per page.

formatint32
maximum100
minimum1
ReturnsExpand Collapse
type TableResponse struct{…}

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.

CreatedAt Time

The timestamp when this table was created.

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

maxLength255
Object Table

The object type, which is always 'table'.

SheetName string

The original Excel sheet name this table came from.

maxLength100
StructuredSheetID string

The ID of the structured sheet this table belongs to.

Type TableResponseType

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

One of the following:
const TableResponseTypeRelational TableResponseType = "relational"
const TableResponseTypeAggregation TableResponseType = "aggregation"
const TableResponseTypeTableless TableResponseType = "tableless"
const TableResponseTypeMetadata TableResponseType = "metadata"

List tables in structured sheet

package main

import (
  "context"
  "fmt"

  "github.com/deeptable-com/deeptable-go"
  "github.com/deeptable-com/deeptable-go/option"
)

func main() {
  client := deeptable.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.StructuredSheets.Tables.List(
    context.TODO(),
    "ss_01kfxgjd94fn9stqm42nejb627",
    deeptable.StructuredSheetTableListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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"
}
Returns Examples
{
  "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"
}