List all Phone Numbers

GET 
/phone_numbers

Returns a list of your Phone Numbers. The phone numbers are returned sorted by creation date, with the most recent phone numbers appearing first. The list is filterable by sending in any of the following parameters.

Permissions

The API token must include the following scopes: Numbers.

Request

Query Parameters

filter_name string

The name given to the phone number. Will return all Phone Numbers containing this value as a substring.

filter_number string

The phone number in E164 format. Will return all Phone Numbers containing this value as a substring.

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "number": "+15558675309",
      "name": "Jenny",
      "call_handler": "relay_context",
      "call_receive_mode": "voice",
      "call_request_url": "",
      "call_request_method": "POST",
      "call_fallback_url": "",
      "call_fallback_method": "POST",
      "call_status_callback_url": "",
      "call_status_callback_method": "POST",
      "call_laml_application_id": null,
      "call_dialogflow_agent_id": null,
      "call_relay_topic": "office",
      "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_context": "my_relay_app",
      "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_relay_application": "my_relay_app",
      "call_relay_connector_id": null,
      "call_sip_endpoint_id": null,
      "call_verto_resource": "",
      "call_video_room_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
      "message_handler": "relay_application",
      "message_request_url": "",
      "message_request_method": "POST",
      "message_fallback_url": "",
      "message_fallback_method": "POST",
      "message_laml_application_id": "null",
      "message_relay_topic": "string",
      "message_relay_context": "my_relay_app",
      "message_relay_application": "my_relay_app",
      "capabilities": [
        "voice",
        "sms",
        "mms",
        "fax"
      ],
      "number_type": "toll-free",
      "e911_address_id": null,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "next_billed_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}