Skip to main content
🤖 LLM Friendly: This page is available in raw Markdown format for LLM consumption:quickstart.md|Get full documentation:llms.txt/llms-full.txt

Quickstart

Get up and running with the Firetell API in just a few minutes.

Prerequisites​

Step 1: Find Your Workspace Domain​

Each workspace has its own API domain. To find yours:

  1. Log in to Firetell Console
  2. Select your workspace
  3. Go to Workspace Settings → General
  4. Note the Domain value (e.g., yourcompany)

Your API base URL will be:

https://{workspace_id}.firetell.app/api/v1
tip

Replace yourcompany in all the examples below with your actual workspace domain.

Step 2: List Phone Numbers​

Verify your API key works by listing the phone numbers in your workspace:

curl -X GET "https://{workspace_id}.firetell.app/api/v1/phone-numbers" \
-H "Authorization: ApiKey YOUR_API_KEY"

Response:

{
"data": [
{
"id": "pn_abc123",
"number": "+84901234567",
"type": "local",
"status": "active"
}
],
"total": 1,
"page": 1,
"limit": 20
}

Step 3: Make a Call​

Initiate an outbound call:

curl -X POST "https://{workspace_id}.firetell.app/api/v1/calls/make" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"from": {
"number": "+84901234567",
"name": "Customer Support"
},
"to": {
"number": "+84909876543",
"name": "John Doe"
}
}'

What's Next?​

Now that you've made your first API call, explore the full capabilities: