Authentication

The API requires an API token to be supplied with every request.

Generating API tokens

  1. Navigate to API keys in your Operating settings
  2. Click Generate a new token. Note that this revokes the previous API token!

You can only have one API token active at any given time.

You need to have the Manage integrations user permission to be able to generate an API token.

🚧

Keep this API token safe

  1. Anyone with the token can access your data through the API!
  2. The token will not be visible again after you navigate away from the page.

Authenticating to the API

To make requests to the API, you need to have an Authorization http header with the valueBearer ${YOUR_API_KEY}.

All API keys have full access to all resources available through the API.