Skip to main content
GET
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

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
provider
string
required
twilio_sid
string
required
is_active
boolean
required
capabilities
Capabilities · object
required
created_at
string<date-time>
required
friendly_name
string | null
is_verified_caller_id
boolean
default:false
sip_trunk_id
string | null
allowed_country_codes
string[] | null
assistant
OrganizationAssistantInfo · object | null

Minimal assistant info for phone number list.

flow
OrganizationFlowInfo · object | null

ConversationFlow information for phone number responses.

updated_at
string<date-time> | null