Using the API: Authentication and First Steps

Getting Started with Our API

This guide will walk you through authenticating with our API and making your first request.

Generating an API Key

Before you can make requests, you need to generate an API key.

1. As an admin, go to 'Settings' > 'Channels' > 'API'.
2. Click the 'Add API Token' button.
3. Give your token a descriptive name to help you identify it later.
4. Copy the generated token. Store it securely, as it will not be shown again.

Making an Authenticated Request

All API requests must be authenticated using your API token. We use Bearer authentication. Include your token in the Authorization header of your requests.

Here is an example using cURL to fetch a list of users:

curl https://api.example.com/v2/users.json \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Rate Limits

Please be aware of our API rate limits, which are documented in our full API reference. Exceeding the rate limit will result in a 429 Too Many Requests error.