> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/grist.md).

# Grist

Read and modify records and table schemas in Grist documents.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Grist     | API Key        |

#### Grist

Connect to Grist to read and modify table records and columns.

**Set up in Grist**

1. Prepare the Grist account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create an API key under Account settings > Developer, then paste it here.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Grist**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required                 | What to enter                                                                                                                         |
| ---------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| API Key          | Yes                      | Create an API key under Account settings > Developer, then paste it here. [Provider instructions](https://docs.getgrist.com/account). |
| Grist Server URL | Optional / as applicable | Use <https://docs.getgrist.com> for a personal site, your team site URL, or the public URL of a self-hosted Grist server.             |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Grist** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Records

List records from a Grist table.

**Inputs**

| Field                  | Type            | Required | Description                                                                                            |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Document ID            | string          | Yes      | Grist document whose records should be read.                                                           |
| Table                  | select (string) | Yes      | Table whose records should be read. Options load from the selected connection.                         |
| Limit                  | integer         | No       | Maximum number of records to return. Default: 100.                                                     |
| Filter                 | object          | No       | Optional column-to-allowed-values filter.                                                              |
| Sort                   | string          | No       | Optional comma-separated column sort order.                                                            |
| Include Hidden Columns | boolean         | No       | Include hidden columns such as manualSort. Default: false.                                             |
| Cell Format            | select (string) | No       | Return compact or self-describing typed cell values. Available values: Normal, Typed. Default: normal. |

**Outputs**

| Field         | Type          | Description                                              |
| ------------- | ------------- | -------------------------------------------------------- |
| Records       | object\_array | Records returned from the Grist table.                   |
| Count         | integer       | Number of records returned.                              |
| May Have More | boolean       | Whether the selected limit may have truncated the table. |

#### Add Records

Add one or more records to a Grist table.

**Inputs**

| Field         | Type            | Required | Description                                                                       |
| ------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Document ID   | string          | Yes      | Grist document to update.                                                         |
| Table         | select (string) | Yes      | Table that should receive the records. Options load from the selected connection. |
| Records       | array           | Yes      | Rows to add, as column-ID to value objects.                                       |
| Parse Strings | boolean         | No       | Let Grist parse strings according to each column type. Default: true.             |

**Outputs**

| Field      | Type    | Description                       |
| ---------- | ------- | --------------------------------- |
| Record IDs | array   | IDs of the created Grist records. |
| Count      | integer | Number of records created.        |

#### Update Records

Update one or more records in a Grist table.

**Inputs**

| Field          | Type            | Required | Description                                                              |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------ |
| Document ID    | string          | Yes      | Grist document to update.                                                |
| Table          | select (string) | Yes      | Table containing the records. Options load from the selected connection. |
| Record Updates | array           | Yes      | Record IDs and column values to update.                                  |
| Parse Strings  | boolean         | No       | Let Grist parse strings according to each column type. Default: true.    |

**Outputs**

| Field   | Type    | Description                         |
| ------- | ------- | ----------------------------------- |
| Updated | boolean | Whether Grist accepted the updates. |
| Count   | integer | Number of records updated.          |

#### Delete Records

Permanently delete records from a Grist table.

**Inputs**

| Field       | Type            | Required | Description                                                              |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------ |
| Document ID | string          | Yes      | Grist document to update.                                                |
| Table       | select (string) | Yes      | Table containing the records. Options load from the selected connection. |
| Record IDs  | array           | Yes      | Numeric IDs of records to permanently delete.                            |

**Outputs**

| Field   | Type    | Description                          |
| ------- | ------- | ------------------------------------ |
| Deleted | boolean | Whether Grist accepted the deletion. |
| Count   | integer | Number of records deleted.           |

#### Add Table Column

Add a column to a Grist table.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                                                      |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Document ID    | string          | Yes      | Grist document whose schema should change.                                                                                                                       |
| Table          | select (string) | Yes      | Table that should receive the column. Options load from the selected connection.                                                                                 |
| Column ID      | string          | Yes      | Stable API identifier for the new column.                                                                                                                        |
| Label          | string          | No       | Optional human-readable column label.                                                                                                                            |
| Column Type    | select (string) | No       | Data type for values in the new column. Available values: Text, Numeric, Integer, Boolean, Date, Date and Time, Choice, Choice List, Attachments. Default: Text. |
| Formula        | textarea        | No       | Optional Grist formula for the column.                                                                                                                           |
| Formula Column | boolean         | No       | Treat this as a formula column. Default: false.                                                                                                                  |

**Outputs**

| Field     | Type    | Description                     |
| --------- | ------- | ------------------------------- |
| Column ID | string  | ID of the created Grist column. |
| Created   | boolean | Whether the column was created. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/grist.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
