Skip to main content
GET
/
phone-numbers
List Phone Numbers
curl --request GET \
  --url https://api.callhq.ai/api/phone-numbers \
  --header 'x-api-key: <api-key>'
{
  "phoneNumbers": [
    {
      "id": "<string>",
      "accountId": "<string>",
      "did": "<string>",
      "domain": "<string>",
      "provider": "<string>",
      "externalId": "<string>",
      "status": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "organization": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ]
}
Retrieve all phone numbers associated with your organization.

​
Overview

This endpoint returns a list of all phone numbers configured for your organization, including their status, provider information, and associated metadata.

​
Request

​
Headers

HeaderValueRequired
x-api-keyYour API keyYes
accept*/*No

​
Example Request

curl -X 'GET' \
  'https://api.callhq.ai/api/phone-numbers' \
  -H 'accept: */*' \
  -H 'x-api-key: your_api_key_here'

​
Response

​
Success Response (200)

Returns an array of phone number objects. 
{
  "phoneNumbers": [
    {
      "id": "1dc31d3f-8e0f-47dd-bfbd-4ac05017b570",
      "accountId": "up-xx-xxxx",
      "did": "91xxxxxx3166",
      "domain": "sip-xx-xx.pliwo.tv",
      "provider": "pliwo",
      "externalId": "aexxxxxx-xxxxxxxx-xxxxxx34579",
      "status": true,
      "createdAt": "2025-07-18T06:52:25.000Z",
      "updatedAt": "2025-07-18T06:52:25.000Z",
      "organization": {
        "id": "e5xxxxxxb-65f7-46cd-b5c3-3bcxxxxx24e",
        "name": "YOUR ORG NAME"
      }
    }
  ]
}

​
Response Schema

FieldTypeDescription
phoneNumbersArrayArray of phone number objects
idStringUnique identifier for the phone number
accountIdStringAccount identifier
didStringDirect inward dialing number
domainStringSIP domain for the phone number
providerStringPhone number provider (e.g., pliwo, telnyx)
externalIdStringExternal identifier from the provider
statusBooleanActive status of the phone number
createdAtString (ISO 8601)Creation timestamp
updatedAtString (ISO 8601)Last update timestamp
organization.idStringOrganization identifier
organization.nameStringOrganization name

​
Error Responses

Status CodeDescription
500Error fetching phone numbers

​
Use Cases

  • Phone Number Management: View all available phone numbers for your organization
  • Provider Integration: Check which phone number providers are configured
  • Status Monitoring: Verify the active status of phone numbers
  • Organization Setup: Review phone number configurations across different accounts

Authorizations

​
x-api-key
string
header
required

Response

List of phone numbers retrieved successfully.

​
phoneNumbers
object[]