Grist API Documentation

This is the complete API documentation for connecting to the Grist API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Grist: Connect to Grist to read, create, and update tables, records, and metadata so you can automate spreadsheet-database workflows across your tools. Keep reading to get started.

Quickstart

Before you run your first Grist request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Grist connection — create or choose one in Connections. Note its connectionId.

Every Grist action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/grist/actions/{actionSlug}/run

You need a MindCloud API Key and a Grist connection. Then call an action such as Get Document:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/grist/actions/get-document/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Grist account. See Grist API Authentication for the full flow and how to get your connection credentials.

Grist actions

All 24 published actions for this Grist version. Each page documents the endpoint, arguments, and response controls.

• POSTAdd Columns
• POSTAdd Records
• POSTAdd Tables
• POSTCreate Document
• POSTCreate Webhook
• DELETEDelete Column
• DELETEDelete Document
• DELETEDelete Records
• DELETEDelete Webhook
• GETGet Document
• GETGet Organization
• GETGet Workspace
• GETList Columns
• GETList Organizations
• GETList Records
• GETList Tables
• GETList Webhooks
• GETList Workspaces
• PUTReplace Columns
• PUTReplace Records
• GETRun SQL Query
• PUTUpdate Records
• PUTUpdate Tables
• PUTUpdate Webhook

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo