Skip to main content
GET
List Organization Phone Numbers
This endpoint retrieves a list of all phone numbers belonging to your organization. It includes information about each number’s assignment status.

Query Parameters

  • include_assigned (boolean, optional, default: true): Set to false to exclude numbers that are currently assigned to an assistant.
  • include_unassigned (boolean, optional, default: true): Set to false to exclude numbers that are not currently assigned to any assistant.

Response

The response is a JSON array of phone number objects. If a number is assigned, the assistant field will contain details about the assistant it’s linked to.
Response

Authorizations

Authorization
string
header
required

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

Query Parameters

include_assigned
boolean
default:true

Include phone numbers assigned to assistants

include_unassigned
boolean
default:true

Include unassigned phone numbers

Response

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 | null

Minimal assistant info for phone number list.

updated_at
string<date-time> | null