List Tables
grist.list_tables
ActionDatabases & warehousesconnection required
Calls the Grist API with the connection's credentials.
List the tables in a Grist document, optionally with their columns.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Grist
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url, doc_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
doc_id Document to act in; overrides the document set on the connection. | string | No | — | — | mR9tqLGSKB2Z |
expand Set to 'column' to include each table's columns in the response. | string | No | none | one of "none", "column" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"doc_id": "mR9tqLGSKB2Z",
"expand": "none"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
tables One object per table in the document. | array | — |
tables[].id The table id. | string | — |
tables[].fields The table's metadata, such as onDemand. | object | — |
count How many tables the document has. | number | — |
doc_id The Grist document the call acted on. | string | — |
{
"count": 0,
"doc_id": "",
"tables": [
{
"fields": {},
"id": ""
}
]
}See List Tables run in a workflow.
In a technical demo we add the Grist connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.