Skip to main content
GET
/
v1
/
phone-numbers
List phone numbers
curl --request GET \
  --url https://api.topcalls.ai/v1/phone-numbers \
  --header 'Authorization: Bearer <token>'
{
  "phone_numbers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "+18005551234",
      "source": "topcalls",
      "status": "active",
      "phone_number_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "voip_carrier_sid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "carrier_name": "<string>",
      "label": "<string>",
      "error_message": "<string>",
      "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Query Parameters

​
status
enum<string>

Filter by status

Available options:
active,
inactive,
pending,
failed,
deleted
​
source
enum<string>

Filter by source

Available options:
topcalls,
byoc,
manual,
import
​
limit
integer
default:50

Maximum number of results (default 50)

Required range: 1 <= x <= 100
​
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

List of phone numbers

​
phone_numbers
object[]
​
count
integer

Total number of phone numbers