Grist icon

Grist

Relational spreadsheet platform for documents, workspaces, tables, records, SCIM users, and webhook subscriptions.

Handles data-driven workflows that add records to tables, create documents and tables, manage SCIM-provisioned users, and clean up unused attachments.

Example Use Cases

These are the Grist actions Snow can use when building apps with you. Connecting an account does not make Snow run these on its own.

Add Records

Add one or more records to a Grist table. First use GRIST_LIST_WORKSPACES to get docId, GRIST_LIST_TABLES to get tableId, and GRIST_LIST_COLUMNS to get column IDs for the fields mapping.

Delete Grist Table Records

Tool to delete records from a specified Grist table. Use when you need to remove specific rows by their IDs. Use after confirming the row IDs exist.

Fetch Document Metadata

Tool to fetch metadata for a specified Grist document. Use after obtaining the document ID.

Fetch Table Metadata

Tool to retrieve metadata for a specified table in a Grist document. Use when you need to inspect table schema details before data operations.

Get Org Access

Retrieves the list of users who have access to a Grist organization along with their access roles (owners, editors, viewers). Use this to find user IDs, emails, or check access permissions within an organization. Useful for user management tasks.

Get Users

Tool to retrieve a list of users via SCIM v2. Use when you need to page through and filter enterprise users in Grist.

List Records

Tool to retrieve records from a specified table within a Grist document. Use when you need to fetch rows by applying optional filters, sorting, limits, or hidden columns. Example: list records where pet is 'cat' sorted by '-age'.

List Tables

Tool to list all tables within a specified document. Use after obtaining the document ID to retrieve its tables.

Run SQL Query

Tool to execute a read-only SQL SELECT query on a Grist document. Use after confirming the document ID and preparing a valid SQL SELECT statement.

Update Records

Update existing records in a Grist table by their row IDs. Use this tool to modify field values for one or more records in a specified document and table. First use GRIST_LIST_RECORDS to obtain the record IDs you want to update. Supports batch updates - you can update multiple records in a single call. The API uses PATCH semantics, meaning only specified fields are updated; unspecified fields remain unchanged. IMPORTANT: When updating multiple records in a batch, all records must specify the exact same set of field names (e.g., if updating Name and Age for record 1, you must also update Name and Age for record 2).