How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Grist

Grist docs API

Workspaces contain collections of Grist documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Grist docs API is one of 17 APIs that Grist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Docs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 42 operations across 39 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, https://{gristhost}/api.

42 operations 39 paths 14 schemas 1 DELETE15 GET5 PATCH21 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://docs.getgrist.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Grist docs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization: Bearer XXXXXXXXXXX) (ApiKey). By default, every request must be authenticated.

  • ApiKey — Access to the Grist API is controlled by an Authorization header, which should contain the word 'Bearer', followed by a space, followed by your API key.

Paths & Operations 42

Across 39 paths, the API surfaces 42 operations — 1 DELETE, 15 GET, 5 PATCH, 21 POST. Each is listed below with its method, path, parameters, and response codes.

docs 42

Workspaces contain collections of Grist documents.

POST
/workspaces/{workspaceId}/docs
Create an empty document
createDoc 1 param body → 200
POST
/workspaces/{workspaceId}/import
Import an existing document
importDoc 1 param body → 200
POST
/docs
Create a document
createDocUnified body → 200
GET
/docs/{docId}
Describe a document
describeDoc 1 param → 200
PATCH
/docs/{docId}
Modify document metadata (but not its contents)
modifyDoc 1 param body → 200
DELETE
/docs/{docId}
Delete a document
deleteDoc 1 param → 200
POST
/docs/{docId}/remove
Move document to trash
removeDoc 2 params → 200
POST
/docs/{docId}/unremove
Restore document from trash
unremoveDoc 1 param → 200
PATCH
/docs/{docId}/move
Move document to another workspace.
moveDoc 1 param body → 200
PATCH
/docs/{docId}/pin
Pin a document
pinDoc 1 param → 200
PATCH
/docs/{docId}/unpin
Unpin a document
unpinDoc 1 param → 200
POST
/docs/{docId}/disable
Disable a document.
disableDoc 1 param → 200403404
POST
/docs/{docId}/enable
Enable a document.
enableDoc 1 param → 200403404
POST
/docs/{docId}/copy
Copies a document to a workspace.
copyDoc 1 param body → 200
POST
/docs/{docId}/fork
Fork a document
forkDoc 1 param → 200400403
GET
/docs/{docId}/access
List users with access to document
listDocAccess 1 param → 200
PATCH
/docs/{docId}/access
Change who has access to document
modifyDocAccess 1 param body → 200
GET
/docs/{docId}/usersForViewAs
Get users for 'View As' feature
getUsersForViewAs 1 param → 200
GET
/docs/{docId}/download
Content of document, as an Sqlite file
downloadDoc 3 params → 200
GET
/docs/{docId}/download/xlsx
Content of document, as an Excel file
downloadDocXlsx 3 params → 200
GET
/docs/{docId}/download/csv
Content of table, as a CSV file
downloadDocCsv 3 params → 200
GET
/docs/{docId}/download/tsv
Content of table, as a TSV file
downloadDocTsv 3 params → 200
GET
/docs/{docId}/download/dsv
Content of table, as a DSV file
downloadDocDsv 3 params → 200
GET
/docs/{docId}/download/table-schema
The schema of a table
downloadTableSchema 3 params → 200
GET
/docs/{docId}/snapshots
List document snapshots
listSnapshots 2 params → 200
POST
/docs/{docId}/snapshots/remove
Remove document snapshots
removeSnapshots 1 param body → 200
GET
/docs/{docId}/states
Get document action history states
getStates 1 param → 200
GET
/docs/{docId}/compare
Compare document versions
compareVersions 4 params → 200403
GET
/docs/{docId}/compare/{docId2}
Compare two documents
compareDocuments 4 params → 200403
POST
/docs/{docId}/states/remove
Truncate the document's action history
deleteActions 1 param body
GET
/docs/{docId}/proposals
List change proposals
listProposals 2 params → 200
POST
/docs/{docId}/propose
Create a change proposal
createProposal 1 param body → 200400
POST
/docs/{docId}/proposals/{proposalId}/apply
Apply a change proposal
applyProposal 2 params → 200
POST
/docs/{docId}/force-reload
Reload a document
forceReload 1 param → 200
POST
/docs/{docId}/flush
Flush document to storage
flushDoc 1 param → 200
POST
/docs/{docId}/assign
Reassign document to appropriate worker
assignDoc 2 params → 200
POST
/docs/{docId}/replace
Replace document content
replaceDoc 1 param body → 200
POST
/docs/{docId}/recover
Set recovery mode for a document
recoverDoc 1 param body → 200403404
GET
/docs/{docId}/timing
Get formula timing status
getTimingStatus 1 param → 200
POST
/docs/{docId}/timing/start
Start formula timing
startTiming 1 param → 200400
POST
/docs/{docId}/timing/stop
Stop formula timing
stopTiming 1 param → 200400
POST
/docs/{docId}/apply
Apply a list of user actions
applyUserActions 2 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are TableSchemaResult (8 properties), Org (7 properties), Doc (5 properties), DocComparison (5 properties). Each schema is shown below with its type and property counts.

Workspace
object
3 properties 3 required
DocAccessRead
DocAccessWrite
DocParameters
object
2 properties
User
object
3 properties 3 required
WorkspaceAccessRead
object
2 properties 2 required
Org
object
7 properties 7 required
DocWithWorkspace
DocComparison
object
Comparison result between two document versions
5 properties 4 required
WorkspaceAccessWrite
object
2 properties
TableSchemaResult
object
8 properties 3 required
Access
string
Doc
object
5 properties 5 required
WorkspaceWithOrg

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grist-docs-api-openapi.yml Raw ↑

Other APIs Grist publishes across the network.

Grist attachments API
AE Profile APIs.io
Grist columns API
AE Profile APIs.io
Grist data API
AE Profile APIs.io
Grist forms API
AE Profile APIs.io
Grist orgs API
AE Profile APIs.io
Grist profile API
AE Profile APIs.io
Grist records API
AE Profile APIs.io
Grist service accounts API
AE Profile APIs.io
Grist session API
AE Profile APIs.io
Grist sql API
AE Profile APIs.io
Grist tables API
AE Profile APIs.io
Grist templates API
AE Profile APIs.io
#Docs
← Back to G APIs
API Details
ID
grist:grist-docs-api
Base URL
https://docs.getgrist.com/api
Docs
https://support.getgrist.com/api/
Provider
Grist
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=grist-docs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/grist-docs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Grist docs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.