Skip to main content

​
Integration Specifications

​
Prerequisites

​
Getting your API key

  1. After logging in to Grist, click the avatar at the top right of the screen, and select Account settings.
    The Grist avatar at the top right and the Account settings menu item highlighted
  2. Select Developer in the left menu.
    The left menu of Grist Account settings with Developer highlighted
  3. Click the API Key field, then copy the API key that appears and save it. If no API key has been issued, click Create to issue one. The Grist Developer screen with the API Key field highlighted
For details on creating an API key, see Grist’s REST API usage (external site).

​
Finding your workspace key

The subdomain in the URL of your Grist team site (https://<subdomain>.getgrist.com/) is the workspace key. Make a note of it for the integration setup.
The URL of a Grist team site with the subdomain highlighted

​
Setting up the integration

  1. In the integration screen, search for Grist.
  2. Enter the API key in API Key and the subdomain in Workspace key, then click Connect. The Grist integration screen where you enter the API key and workspace key
  3. When the integration with Grist succeeds, registered user information appears in the account list. If it does not complete successfully, first try the steps in Troubleshoot SaaS integration errors. If the issue persists, check Information to provide and contact Support.
  • Use an API key from the account of an owner of the team site. An API key from any other account cannot retrieve the account list.
  • Admina cannot delete the owner accounts of the team site.
Last modified on November 13, 2026