Get Phone Number

GET /api/phone-numbers/{phone_number_id}

Get Phone Number

cURL

curl --request GET \
  --url https://api.example.com/api/phone-numbers/{phone_number_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'

Response

{
  "success": true,
  "data": {
    "phone_number_id": "phon_a1b2c3d4e5f6",
    "phone_number": "[phone]",
    "client_id": "org_abc123",
    "provider": "twilio",
    "status": "assigned",
    "supports_inbound": true,
    "supports_outbound": true,
    "assigned_agent_id": "agent_b2c3d4e5f6a7",
    "integration_id": "intg_c3d4e5f6a7b8",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}

Get details of a specific phone number.

Headers

X-API-Key · string · required

Your API key for authentication.

X-Organization-Id · string · required

The organization ID.

Path Parameters

phone_number_id · string · required

The unique identifier of the phone number (format: phon_[a-f0-9]{12,}).

Permissions

• phone_numbers:read (all roles)

Response

success · boolean

Indicates if the request was successful.

data · object

The full phone number configuration object.

Show properties

phone_number_id · string

Unique phone number identifier.

phone_number · string

The phone number in E.164 format.

client_id · string

Organization ID.

provider · string

Provider type (twilio or sip).

status · string

Status (free or assigned).

supports_inbound · boolean

Whether number supports inbound calls.

supports_outbound · boolean

Whether number supports outbound calls.

assigned_agent_id · string

ID of assigned agent (if any).

integration_id · string

Integration ID (for Twilio numbers).

sip_trunk_info · object

SIP trunk configuration (for SIP numbers).

created_at · string

ISO 8601 timestamp of creation.

updated_at · string

ISO 8601 timestamp of last update.

Response

{
  "success": true,
  "data": {
    "phone_number_id": "phon_a1b2c3d4e5f6",
    "phone_number": "[phone]",
    "client_id": "org_abc123",
    "provider": "twilio",
    "status": "assigned",
    "supports_inbound": true,
    "supports_outbound": true,
    "assigned_agent_id": "agent_b2c3d4e5f6a7",
    "integration_id": "intg_c3d4e5f6a7b8",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}