Skip to main content

Overview

To authenticate with Grist, you need:
  1. Environment - The environment you want to connect to (personal site or team site).
  2. API Key - A key that grants secure access to the Grist API, enabling authorized applications to interact with Grist resources and services.
This guide will walk you through selecting your environment and generating your API Key within Grist.

Prerequisites:

  • You must have a Grist account

Instructions:

Step 1: Selecting Your Environment

  • To access documents on your personal site, use docs.
  • To access documents and workspaces on a team site, use team.

Step 2: Generating Your API Key

  1. Log in to your Grist account and navigate to the Account settings page.
  2. If an API Key is not present, click the Create button. If an API key already exists, you can copy it.

Step 3: Enter credentials in the Connect UI

Once you have your API Key:
  1. Open the form where you need to authenticate with Grist.
  2. Enter your API Key in the designated field.
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Grist.