- Category: productivity
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 30
- Triggers: 0
- Slug:
GRIST - Version: 20261101_00
Tools
Add Records
Add Records
GRIST_ADD_RECORDSAdd 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.Input Parameters
Output
Create Document
Create Document
Create SCIM User
Create SCIM User
Create Table
Create Table
GRIST_CREATE_TABLETool to create tables in a document. Use after confirming the document ID. Creates one or more tables with specified columns in the given document.Input Parameters
Output
Create Document Webhook
Create Document Webhook
GRIST_CREATE_WEBHOOKTool to create a new webhook for a specified document. Use when you need to register webhook endpoints for document events in Grist. Run after confirming document ID.Input Parameters
Output
Remove Unused Attachments
Remove Unused Attachments
GRIST_DELETE_ATTACHMENTRemove unused attachments from a Grist document to free up storage space. IMPORTANT: This action removes ALL attachments that are not currently referenced by any cell in the document. It does NOT delete a specific attachment by ID. To remove a specific attachment: 1. First remove its reference from the Attachments column cell that contains it 2. Then call this action to clean up the now-unreferenced file Attachments become “unused” when they are no longer referenced by any Attachments-type cell. Grist normally retains unreferenced attachments for a period to allow undo operations. This action removes them immediately (or only expired ones if expired_only=true).Input Parameters
Output
Delete Column
Delete Column
GRIST_DELETE_COLUMNTool to delete a column from a Grist document table. Use after confirming document, table, and column IDs.Input Parameters
Output
Delete Grist Table Records
Delete Grist Table Records
GRIST_DELETE_RECORDSTool 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.Input Parameters
Output
Delete SCIM User
Delete SCIM User
GRIST_DELETE_SCIM_USERDelete a Grist SCIM user by numeric user ID. In some cases, the operation instead removes the user’s access to the first listed organization, or the current organization if none is listed; this is not a SCIM user deletion.Input Parameters
Output
Delete Webhook
Delete Webhook
GRIST_DELETE_WEBHOOKPermanently removes a webhook from a Grist document. Use this tool when you need to stop receiving notifications for document changes. First use GRIST_LIST_WEBHOOKS to find the webhook_id you want to delete. This action is destructive and cannot be undone.Input Parameters
Output
Download All Attachments Archive
Download All Attachments Archive
GRIST_DOWNLOAD_ALL_ATTACHMENTS_ARCHIVEDownload all attachments from a Grist document as a single archive file (.zip or .tar). Use this to bulk-download attachments. Ensure the document has attachments before calling (check with GRIST_LIST_ATTACHMENTS). Returns an empty archive if no attachments exist.Input Parameters
Output
Download Attachment
Download Attachment
GRIST_DOWNLOAD_ATTACHMENTDownload a file attachment from a Grist document. Returns the file content as a downloadable file. Use GRIST_LIST_ATTACHMENTS first to get valid attachment IDs.Input Parameters
Output
Fetch Document Metadata
Fetch Document Metadata
GRIST_FETCH_DOCUMENT_METADATATool to fetch metadata for a specified Grist document. Use after obtaining the document ID.Input Parameters
Output
Fetch Table Metadata
Fetch Table Metadata
Get Org Access
Get Org Access
Get Users
Get Users
List Attachments
List Attachments
GRIST_LIST_ATTACHMENTSTool to list all attachments in a Grist document. Use after confirming the document ID to retrieve attachment metadata.Input Parameters
Output
List Columns
List Columns
GRIST_LIST_COLUMNSList columns and their metadata in a specified Grist table. Hidden columns are included when requested.Input Parameters
Output
List Organizations
List Organizations
List Records
List Records
GRIST_LIST_RECORDSTool 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’.Input Parameters
Output
List Tables
List Tables
List Webhooks
List Webhooks
GRIST_LIST_WEBHOOKSList all webhooks configured for a Grist document. Returns webhook configuration details (URL, event types, table binding) and delivery status information. Use this to inspect, audit, or manage webhooks for a document. Requires a valid document ID obtained from GRIST_LIST_WORKSPACES or GRIST_CREATE_DOCUMENT.Input Parameters
Output
List Workspaces
List Workspaces
Run SQL Query
Run SQL Query
GRIST_RUN_SQL_QUERYTool 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.Input Parameters
Output
Update Column Metadata
Update Column Metadata
GRIST_UPDATE_COLUMN_METADATAUpdates metadata (label, type, description, formula, etc.) for one or more columns in a Grist table. Use List Columns first to get valid column IDs. Warning: changing ‘label’ may rename the column ID unless ‘untieColIdFromLabel’ is set to true.Input Parameters
Output
Update Document Metadata
Update Document Metadata
GRIST_UPDATE_DOCUMENT_METADATATool to update metadata for a specified Grist document. Use when you need to rename or pin/unpin a document after obtaining its ID.Input Parameters
Output
Update Records
Update Records
GRIST_UPDATE_RECORDSUpdate 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).Input Parameters
Output
Update Table Metadata
Update Table Metadata
GRIST_UPDATE_TABLE_METADATAUpdate metadata for a table in a Grist document, including its table ID for renaming or its on-demand loading setting. The response echoes the requested update.Input Parameters
Output
Update Webhook
Update Webhook
GRIST_UPDATE_WEBHOOKUpdate an existing webhook on a Grist document, changing provided settings such as its URL, event types, enabled status, or target table. Omitted settings remain unchanged. An update may take effect even when the tool reports an error.Input Parameters
Output
Upload Attachment
Upload Attachment
GRIST_UPLOAD_ATTACHMENTUpload one or more file attachments to a Grist document. Returns attachment IDs that can be used to link files to records in Attachments-type columns. First use GRIST_LIST_WORKSPACES to get a valid document ID.