Skip to content
DeepTable
Get started
API Reference
Structured Sheets

List structured sheets

client.StructuredSheets.List(ctx, query) (*CursorIDPage[StructuredSheetResponse], error)
GET/v1/structured-sheets

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

ParametersExpand Collapse
query StructuredSheetListParams
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 results to return per page.

formatint32
maximum100
minimum1
ReturnsExpand Collapse
type StructuredSheetResponse struct{…}

Response representing a structured sheet conversion job.

This is returned from POST (create), GET (retrieve), and list endpoints.

ID string

The unique identifier for this structured sheet conversion.

CreatedAt Time

The timestamp when the conversion was started.

formatdate-time
FileID string

The unique identifier for the source file.

Object StructuredSheet

The object type, which is always 'structured_sheet'.

Status StructuredSheetResponseStatus

The current processing status.

One of the following:
const StructuredSheetResponseStatusQueued StructuredSheetResponseStatus = "queued"
const StructuredSheetResponseStatusInProgress StructuredSheetResponseStatus = "in_progress"
const StructuredSheetResponseStatusCompleted StructuredSheetResponseStatus = "completed"
const StructuredSheetResponseStatusFailed StructuredSheetResponseStatus = "failed"
const StructuredSheetResponseStatusCancelled StructuredSheetResponseStatus = "cancelled"
UpdatedAt Time

The timestamp when the conversion was last updated.

formatdate-time
LastError StructuredSheetResponseLastErroroptional

Error information when processing fails.

Code string

A machine-readable error code.

maxLength64
Message string

A human-readable description of the error.

maxLength1024
SheetNames []stringoptional

List of sheet names included in this conversion.

TableCount int64optional

Number of tables extracted from the workbook. Only present when status is 'completed'.

minimum0

List structured sheets

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.List(context.TODO(), deeptable.StructuredSheetListParams{

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

{
  "data": [
    {
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "object": "structured_sheet",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "table_count": 6
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627"
}
Returns Examples
{
  "data": [
    {
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "object": "structured_sheet",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "table_count": 6
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627"
}