Skip to main content
GET
/
api
/
v1
/
assistants
/
organization
/
phone-numbers
/
available
List Available Phone Numbers
curl --request GET \
  --url https://api.example.com/api/v1/assistants/organization/phone-numbers/available \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "phone_number": "<string>",
    "twilio_sid": "<string>",
    "is_active": true,
    "capabilities": {},
    "created_at": "2023-11-07T05:31:56Z",
    "friendly_name": "<string>",
    "assistant": {
      "id": 123,
      "name": "<string>",
      "is_active": true
    },
    "updated_at": "2023-11-07T05:31:56Z"
  }
]
This endpoint is a convenient way to retrieve a list of all phone numbers in your organization that are not currently assigned to an assistant. This is useful for finding numbers that are available to be linked to a new or existing assistant. This endpoint takes no parameters.

​
Response

The response is a JSON array of phone number objects. The assistant field for each object will be null.
Response
[
  {
    "id": 2,
    "phone_number": "+15557654321",
    "friendly_name": "Sales Department",
    "twilio_sid": "PNyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
    "is_active": true,
    "capabilities": { "voice": true, "sms": false, "mms": false },
    "assistant": null,
    "created_at": "2023-10-02T12:00:00Z",
    "updated_at": null
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

​
id
integer
required
​
phone_number
string
required
​
twilio_sid
string
required
​
is_active
boolean
required
​
capabilities
Capabilities · object
required
​
created_at
string<date-time>
required
​
friendly_name
string | null
​
assistant
OrganizationAssistantInfo · object

Minimal assistant info for phone number list.

​
updated_at
string<date-time> | null