List Columns
grist.list_columns
ActionDatabases & warehousesconnection required
Calls the Grist API with the connection's credentials.
List the columns of a table, with each column's type and label.
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
3 fields, 1 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 |
|---|---|---|---|---|---|
table_id The table to act on, as its table id (the TABLE ID shown in Raw Data). | string | Yes | — | — | People |
doc_id Document to act in; overrides the document set on the connection. | string | No | — | — | mR9tqLGSKB2Z |
hidden Include Grist's hidden columns, such as manualSort, in the listing. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"doc_id": "mR9tqLGSKB2Z",
"hidden": false,
"table_id": "People"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
columns One object per column in the table. | array | — |
columns[].id The column id. | string | — |
columns[].fields The column's metadata: label, type, isFormula and formula. | object | — |
count How many columns the table has. | number | — |
table_id The table id the call acted on. | string | — |
doc_id The Grist document the call acted on. | string | — |
{
"columns": [
{
"fields": {},
"id": ""
}
],
"count": 0,
"doc_id": "",
"table_id": ""
}See List Columns 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.