List Organization Phone Numbers

List all phone numbers in your organization.

Returns phone numbers with their assignment status and assistant information.

GET /api/v1/assistants/organization/phone-numbers

List Organization Phone Numbers

cURL

curl --request GET \
  --url https://api.example.com/api/v1/assistants/organization/phone-numbers \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "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 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

[
  {
    "id": 1,
    "phone_number": "[phone]",
    "friendly_name": "Main Support Line",
    "twilio_sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "is_active": true,
    "capabilities": { "voice": true, "sms": true, "mms": true },
    "assistant": {
      "id": 123,
      "name": "Customer Service Bot",
      "is_active": true
    },
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-26T11:00:00Z"
  },
  {
    "id": 2,
    "phone_number": "[phone]",
    "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.

Query Parameters

include_assigned · boolean · default: true

Include phone numbers assigned to assistants

include_unassigned · boolean · default: true

Include unassigned phone numbers

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

Show child attributes

created_at · string<date-time> · required

friendly_name · string | null

assistant · OrganizationAssistantInfo · object

Minimal assistant info for phone number list.

Show child attributes

updated_at · string<date-time> | null