List tables in a document | Grist Octri Preview

2 parameters

docIdstringrequired

The document identifier, as a UUID string.

expandstringoptional

Set to `column` to include column metadata for each table in the response.

Allowed:column

1 status code

200Returns an object containing a `tables` array; each table includes its `id` and `fields`, and may include column metadata.

tablesarray<object>required

Error handling

The docId path parameter is described as a UUID string. The expand query parameter accepts only column when supplied.

import (
	"context"
	"fmt"
	"log"
	"os"

	gristoctripreview "github.com/grist_octri_preview_sdk/sdk"
)

ctx := context.Background()
client := gristoctripreview.NewGristOctriPreview(gristoctripreview.ClientConfig{
	BaseURL: "https://docs.getgrist.com/api",
	Auth: &gristoctripreview.ClientAuthConfig{ApiKey: os.Getenv("API_TOKEN")},
})

result, err := client.Tables.List(
	ctx,
	gristoctripreview.ListTablesParams{DocId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"},
)
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

{
  "tables": [
    {
      "fields": {
        "onDemand": false,
        "tableRef": 1
      },
      "id": "People"
    },
    {
      "fields": {
        "onDemand": false,
        "tableRef": 2
      },
      "id": "Places"
    }
  ]
}

Request

Response

Errors