Authentication

All Firetell API endpoints require authentication. This guide explains how to obtain and use your API credentials.

API Keys

API keys are managed through the Firetell Console. Each API key is scoped to a specific workspace.

Creating an API Key

1. Log in to the Firetell Console
2. Navigate to Settings → API Keys
3. Click Create API Key
4. Give your key a descriptive name
5. Copy and securely store the generated key

caution

API keys are shown only once at creation time. Store them securely and never expose them in client-side code.

Using Bearer Tokens

Include your API key in the Authorization header of every request:

curl -X GET "https://yourcompany.firetell.app/api/1.0/phone-numbers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

tip

Replace yourcompany with your workspace's subdomain. You can find it in Firetell Console → Workspace Settings → General.

Workspace Scope

All API operations are scoped to the workspace associated with the API key. You cannot access resources from other workspaces with a single key.

Rate Limiting

API requests are rate-limited to protect service quality. If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Tier	Requests per minute
Default	60
Enterprise	Custom

Error Responses

Authentication failures return a 401 Unauthorized response:

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Invalid or expired API key"
}

Next Steps

• Quickstart — Make your first API call
• API Reference — Explore all endpoints