Skip to main content

API Authentication

Our API uses API keys for authentication. This guide explains how to create and use API keys with our platform.

Creating an API Key​

To create an API key:

  1. Log in to your account
  2. In your team, navigate to API keys
  3. In the top-right corner, click Create new Key
  4. Give it a name
  5. Select the appropriate scopes (permissions)
  6. Save your API key securely - it will only be shown once

Using Your API Key​

Include your API key in the Authorization header of your requests:

Authorization: Bearer YOUR_API_KEY

API Key Security​

  • Never share your API key or commit it to version control
  • Use environment variables to store your API key in your applications
  • Rotate your API keys periodically
  • Use scopes to limit the permissions of each API key

Updating API Keys​

If you need to update an API key, you can do so by:

  1. In your team, navigate to API keys
  2. Click the pencil icon to edit the key
  3. Change the name or scopes.
  4. Click Update

Disabling API Keys​

If you need to disable an API key, you can do so by:

  1. In your team, navigate to API keys
  2. Click the pencil icon to edit the key
  3. Click Disable
  4. You key is now disabled.

Revoking API Keys​

If an API key is compromised, you can revoke it immediately:

  1. In your team, navigate to API keys
  2. Click the pencil icon to edit the key
  3. Click Delete API key + Are you sure?
  4. Your key is now delete. This action cannot be undone.

Next: API Scopes →