API Reference

Structured Sheets

Tables

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve a table

client.StructuredSheets.Tables.Get(ctx, tableID, query) (*TableResponse, error)

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

ParametersExpand Collapse

tableID string

The unique identifier of the table.

query StructuredSheetTableGetParams

StructuredSheetID param.Field[string]

The unique identifier of the structured sheet conversion.

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"

Retrieve a table

Go

HTTP

TypeScript

Python

Go

CLI Tool

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"),
  )
  tableResponse, err := client.StructuredSheets.Tables.Get(
    context.TODO(),
    "tbl_01kfxgjd94fn9stqm45rqr2pnz",
    deeptable.StructuredSheetTableGetParams{
      StructuredSheetID: "ss_01kfxgjd94fn9stqm42nejb627",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tableResponse.ID)
}

200 example

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

Returns Examples

200 example

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