Skip to main content

Get your API credentials

Before your developers can call the platform's API, they need a credential that identifies your account and authorizes each request. This page explains how to generate an API key, where to find it later, and how to keep it secure.

Before you begin​

  • You need an account role with permission to manage API access. If you don't see the developer or API settings, ask an admin to grant access or to generate the key for you.
  • Decide which integration or environment the key is for. A separate key per integration makes it easier to rotate or revoke one without disrupting the others.
  • Have a secure place ready to store the key, such as a secrets manager or your application's protected configuration. The key is shown in full only once.

Steps​

  1. Sign in and open the API or developer settings area of your account (confirm the exact steps in your account).
  2. Choose the option to create a new API key or credential.
  3. Give the key a descriptive name (for example, the integration or environment it serves) so you can identify it later.
  4. If prompted, scope the key to only the permissions your integration needs.
  5. Generate the key, then copy the full value immediately and store it in your secrets store. Once you leave the page, only a masked or partial version is shown.

Result​

Your integration can now authenticate requests using the key. Send a simple authenticated request to confirm it succeeds; a 401/403 response usually means the key was copied incorrectly, has been revoked, or lacks the required permission. To rotate a key, generate a new one, update your integration, then revoke the old one.

Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.