Sign in
Phone Number Addresses

List phone number addresses

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.

get/api/fabric/phone_number_addresses

Query parameters

page_sizeinteger

The number of results per page.

page_numberinteger

The page index, used together with page_token.

page_tokenstring

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

Response

The request has succeeded.

items_countinteger required

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

Example response

{
  "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": [
    {
      "type": "phone",
      "name": "main-support-number",
      "phone_number": "+13105550100",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z"
    }
  ]
}

Changes

Changed in 4 of the 161 revisions of this API.113

  • 7506aebc9ef31See the full diff
    • ○

      endpoint added

      endpoint-added

  • f0464a93a3621See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 525afaa1e83211See the full diff
    • ●

      added the new phone enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      removed the phone_number_address enum value from the // response property for the response status

      response-property-enum-value-removed

  • e35eaf5d474d1See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 161 revisions, 3 have a changelog that could not be searched.