Phone Numbers
List the organization numbers an org-line picker may offer
Admins (Admin, SuperAdmin) get every phone number in the organization. Anyone else gets only the numbers they may send from: linked to them or to a group they belong to, shared with them by a send grant, or the org default line (anyone may send from it). Rows carry the linked user's name or group name and via; via is null on a row an admin sees only because they are an admin. Same channel narrowing as GET /api/phone-numbers.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
channel?string
Only numbers usable to start a conversation on this channel: the organization's active provider for it, the capability, and active status. Omit for every number.
Value in
- "sms"
- "voice"
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/phone-numbers/org"{ "phoneNumbers": [ { "phoneNumberId": "string", "provider": "string", "phoneNumber": "string", "numberType": "longcode", "capabilities": [ "sms" ], "status": "active", "label": "string", "routing": {}, "linkedType": "user", "linkedUserId": "string", "linkedGroupId": "string", "groupName": "string", "userName": "string", "via": "link" } ]}