Get Phone Numbers
Retrieve every phone number in the workspace.
This is the same endpoint as List Phone Numbers. It returns all phone numbers in the workspace, not only those added by the calling user. The caller's role needs phone number view permission (otherwise 403 {"error": "Insufficient permissions"}).
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Response
The response is a JSON array of phone number objects (not wrapped in an object). An empty workspace returns []. Commonly used fields:
_idstringPhone number record ID.
phoneNumberstringThe number in E.164 format.
sidstringProvider identifier for the number.
providerstringtwilio, sip, telnyx, commschannel or whatsapp.
isExternalbooleantrue for numbers imported from your own carrier account.
countrystringCountry code of the number.
statusstringready, active, released, reserved or error.
flowTypestringWhat the number is bound to: call, message, both or undefined.
agentIdobjectThe bound agent, returned as the full agent object, or null.
pathwayIdobjectThe bound call flow, returned as the full call flow object, or null.
messagePathwayIdobjectThe bound message flow object, or null.
omniFlowAgentIdobjectThe bound omni-channel agent object, or null.
recordingEnabledbooleanWhether call recording is enabled on the number.
monthlyPricenumberMonthly price of the number.
scheduledReleaseAtstringISO date when a cancelled number will be released, or null.
cancelAtPeriodEndbooleanWhether the number's subscription is set to cancel at the end of the period.
subscriptionStatusstringStatus of the number's subscription, or null.
subscriptionExpiresAtstringWhen the subscription expires, or null.
createdAtstringCreation timestamp.
Example Response
[
{
"_id": "d7d7d7d7d7d7d7d7d7d7d7d7",
"workspaceId": "d1d1d1d1d1d1d1d1d1d1d1d1",
"phoneNumber": "+14155550123",
"sid": "PN0123456789abcdef0123456789abcdef",
"country": "US",
"type": "local",
"provider": "twilio",
"isExternal": false,
"status": "active",
"flowType": "call",
"agentId": { "_id": "d3d3d3d3d3d3d3d3d3d3d3d3", "name": "Front Desk" },
"pathwayId": { "_id": "d4d4d4d4d4d4d4d4d4d4d4d4", "name": "Appointment Booking" },
"messagePathwayId": null,
"omniFlowAgentId": null,
"recordingEnabled": true,
"monthlyPrice": 6.79,
"scheduledReleaseAt": null,
"cancelAtPeriodEnd": false,
"subscriptionStatus": "active",
"subscriptionExpiresAt": "2026-11-29T00:00:00.000Z",
"createdAt": "2026-10-29T10:00:00.000Z",
"updatedAt": "2026-10-29T10:00:00.000Z"
}
]Last updated on