Phone Numbers
List Phone Numbers
List all phone numbers in your account
GET
Request
Retrieve a list of all phone numbers associated with your account.Headers
Bearer token for authentication. Format:
Bearer YOUR_API_KEYQuery Parameters
Number of phone numbers to return (1-100)
Pagination cursor from a previous response
Filter by status:
active, pending, inactiveFilter by country code (e.g.,
US, GB, CA)Response
Array of phone number objects
Whether there are more results available
Cursor for fetching the next page
Total number of phone numbers
Phone Number Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier |
phone_number | string | E.164 formatted number |
friendly_name | string | Display name |
country | string | Two-letter country code |
region | string | State/region code |
capabilities | object | Voice and SMS capabilities |
status | string | active, pending, inactive |
default_agent_id | string | Agent for incoming calls |
created_at | string | ISO 8601 timestamp |
Error Codes
| Code | Description |
|---|---|
invalid_cursor | The pagination cursor is invalid |
invalid_country | Country code is not valid |