Authentication (API)

Authenticate requests to the Authentication & Connect API with an encrypted API key associated with your user account.

Get an active API key

Sign in to the Communications Platform UI with an account that has the Admin role.
Open Preferences, then select the API tab.
Copy the designated API key from your account.

Use this API key when building integrations that interact with your Platform account. For more details, see Access your API Key.

Send your API key

Include the key in the Authorization header of every request, using the Bearer scheme:

Authorization: Bearer <your_api_key>

⚠️
About the JWT tab in the interactive explorer
The interactive API explorer shows a JWT tab alongside Bearer. This project only uses Bearer authentication -- the JWT tab does not apply and can be ignored.

📘
NOTE
Users who are not Admin should request the API Key from the Admin user and not from the support team or the commercial representative.