REST API Overview

The Firetell REST API allows you to programmatically manage your cloud communications infrastructure.

Base URL

Each workspace has its own API domain:

https://{workspace_id}.firetell.app/api/1.0

Replace {workspace_id} with your workspace's subdomain (found in Console → Workspace Settings → General).

All endpoints are relative to this base URL.

Request Format

• All requests use HTTPS
• Request bodies must be JSON with Content-Type: application/json
• Authentication via Bearer Token in the Authorization header

Example Request

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

Response Format

All responses return JSON. Successful responses include a data field:

{
  "data": { ... },
  "total": 100,
  "page": 1,
  "limit": 20
}

HTTP Status Codes

Code	Description
200	Success
201	Resource created
400	Bad request — invalid parameters
401	Unauthorized — invalid or missing API key
403	Forbidden — insufficient permissions
404	Resource not found
429	Rate limit exceeded
500	Internal server error

Error Response Format

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request",
  "details": [
    {
      "field": "to",
      "message": "Phone number is required"
    }
  ]
}

Pagination

List endpoints support pagination with the following query parameters:

Parameter	Type	Default	Description
page	number	1	Page number
limit	number	20	Items per page (max 100)
search	string	—	Text search filter
sort	string	—	Sort field
order	string	desc	Sort order (asc or desc)

Available Resources

Resource	Description
Phone Numbers	Manage virtual phone numbers
Call	Make and control calls
Call Flows	Manage IVR call flows
Extensions	Manage internal extensions
SIP Trunks	Manage SIP trunk connections
SIP Accounts	Manage SIP accounts
Members	Manage workspace members
Teams	Manage agent teams
Agents	Manage call center agents
Voice Agents	Manage AI voice agents
Audios	Manage audio files
Webhooks	Manage webhook endpoints