List Phone Numbers
Retrieve all phone numbers associated with your workspace.
GET
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
phoneNumbersarrayArray of phone number objects.
_idstringUnique identifier for the phone number record.
phoneNumberstringThe phone number in E.164 format (e.g., +14155551234).
providerstringThe telephony provider (e.g., "twilio", "sip").
countrystringCountry code of the phone number (e.g., "US", "AU").
typestringType of phone number (e.g., "local", "tollFree", "mobile").
statusstringCurrent status of the phone number.
workspaceIdstringWorkspace ID associated with the phone number.
labelstringOptional label for the phone number.
{
"phoneNumbers": [
{
"_id": "665a1b2c3d4e5f6a7b8c9d0e",
"phoneNumber": "+14155551234",
"provider": "twilio",
"country": "US",
"type": "local",
"status": "active",
"workspaceId": "664a1b2c3d4e5f6a7b8c9d0e",
"label": "Sales Line"
}
]
}