Grist

Productivity Host and API key

Read and write Grist documents, tables and records from any Windmill script, flow or app.

Set up in 3 steps

Copy your API key

In Grist, open your profile settings and copy the API key.

Add the resource in Windmill

Open Resources, add a resource of type grist. host is docs.getgrist.com for the hosted service, or your team site or self-hosted address; apiKey is the key.

Run your first script

Fork any script below and read before writing anything. There are dozens here, so search by the verb you need.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

grist — the shape of the credential every script on this page expects.

View raw schema →

Field	Type	Required	What it is
apiKey	string	Yes	API key retrieved from the profile settings.
host	string	Yes	Base URL of the API - for personal workspace, use docs.getgrist.com and for team workspace, use team URL.

All resource types

Grist

Grist Document

Questions

What goes in host?

The host serving your documents — docs.getgrist.com, a team site like acme.getgrist.com, or your own server. Every request is built from it, so a team key does not answer on the generic host.

Is my key stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.

Set up in 3 steps

Copy your API key

Add the resource in Windmill

Run your first script

Scripts

Webhooks associated with a document

Upload attachments to a doc

The schema of a table

Run an SQL query against a document, with options or parameters

Run an SQL query against a document

Retrieve user by ID

Retrieve service provider configuration

Retrieve list of users

Retrieve information about oneself

Retrieve SCIM schemas

Retrieve SCIM resource types

Remove a webhook

Reload a document

Move document to another workspace.

Modify tables of a document

Modify rows of a table

Modify records of a table

Modify document metadata (but not its contents)

Modify columns of a table

Modify an org

Modify a workspace

Modify a webhook

List workspaces and documents within an org

List users with access to workspace

List users with access to org

List users with access to document

List the orgs you have access to

List tables in a document

List metadata of all attachments in a doc

List columns in a table

Resource type

All resource types

Grist

Grist Document

Questions