List phone number addresses

Beta

GET

https://{your_space_name}.signalwire.com/api/fabric/phone_number_addresses

GET

/api/fabric/phone_number_addresses

curl https://{your_space_name}.signalwire.com/api/fabric/phone_number_addresses \
     -u "<project_id>:<api_token>"

{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/phone_number_addresses?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/phone_number_addresses?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/phone_number_addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/phone_number_addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  },
  "items_count": 1,
  "data": [
    {
      "id": "b3f1c0a2-0f6e-4a9d-9b2a-1c2d3e4f5a6b",
      "type": "phone",
      "handler_type": "calling",
      "resource_id": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
      "name": "main-support-number",
      "phone_number": "+13105550100",
      "phone_number_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z"
    }
  ]
}

Lists the phone number addresses in your SignalWire project, newest first. Each address represents one channel (calling or messaging) of a phone number you own, together with the resource that handles it, if any. Addresses whose number has been released are not included. Use it to find the address ID for a number’s channel before you link, re-point, or remove its resource.

Only the pagination parameters are supported; there are no filters. A page_token that is malformed or no longer resolves returns a 422 with the code page_token_is_invalid.

Beta

This API is in beta and may change.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Calling, Fax, Messaging, or Video.

Learn more about API scopes.

Lists the phone number addresses in your SignalWire project, newest first. Each address represents one channel (`calling` or `messaging`) of a phone number you own, together with the resource that handles it, if any. Addresses whose number has been released are not included. Use it to find the address ID for a number's channel before you link, re-point, or remove its resource. Only the pagination parameters are supported; there are no filters. A `page_token` that is malformed or no longer resolves returns a `422` with the code `page_token_is_invalid`. <Warning title="Beta">This API is in beta and may change.</Warning> #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Calling_, _Fax_, _Messaging_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

page_sizeintegerOptional1-1000Defaults to 50

The number of results per page.

page_numberintegerOptional>=0Defaults to 0

The page index, used together with page_token.

page_tokenstringOptional

Opaque cursor token from a previous response’s links.next or links.prev. Begins with PA or PB.

Response

The request has succeeded.

linksobject

Pagination links for the response.

items_countinteger

The number of phone number addresses in this page of results.

datalist of objects

An array of phone number address objects.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error