Phone Numbers
List the phone numbers the caller may send from (or read)
Every org phone number the caller may use for verb (default send). For send: linked to them, linked to a user group they belong to, or shared with them through a send grant (to them, their department or one of their groups). For read: shared with them through a read grant only - a link gives send, never read. Each row says how in via and lists every verb the caller holds on it in verbs. The default list is the send-from picker set and never contains a line the caller may only read. ?verb=read returns the lines whose conversations the caller can see (for filtering realtime line events); it can include read-only lines, which are not send-from options. Admins get no widening here: these are the lines that are theirs, not every line in the org. The org default line is never a send row; orgDefaultAvailable says whether one covers the requested channel. It appears in the read set only through an explicit read grant. With ?channel=sms|voice only numbers usable to start a conversation on that channel are returned (the active provider for the channel, the capability, active status). Any authenticated user.
Authorization
bearerAuth In: header
Query Parameters
send (default): lines the caller may send from. read: lines whose conversations the caller can see through a read grant.
"send"Value in
- "send"
- "read"
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
application/json
curl -X GET "https://example.com/api/phone-numbers"{ "phoneNumbers": [ { "phoneNumberId": "6650a1b2c3d4e5f6a7b8c9d1", "provider": "twilio", "phoneNumber": "+14165550102", "capabilities": [ "sms", "voice" ], "status": "active", "label": "Leasing team line", "via": "grant", "verbs": [ "send", "read" ] } ], "orgDefaultAvailable": true}