List alias addresses

GET

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

GET

/api/fabric/alias_addresses

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

{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  },
  "items_count": 1,
  "data": [
    {
      "id": "8f14e45f-ceea-467d-9c2b-7a1d3a9b2c34",
      "type": "alias",
      "resource_id": "b3877739-5c7e-4d4f-9d1a-2f0c8c2f1a11",
      "name": "support",
      "display_name": "Support Line",
      "display_type": "app",
      "channels": [
        "audio",
        "messaging",
        "video"
      ],
      "codecs": [],
      "context": "public",
      "uri": "/public/support",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z"
    }
  ]
}

Lists the alias addresses in your SignalWire project. An alias is a named route in the public or private context that forwards calls and messages to the resource it points at. SIP addresses and phone numbers are managed through their own operations.

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 alias addresses in your SignalWire project. An alias is a named route in the `public` or `private` context that forwards calls and messages to the resource it points at. [SIP addresses](/docs/apis/rest/sip-addresses/list-sip-addresses) and [phone numbers](/docs/apis/rest/phone-numbers/list-phone-numbers) are managed through their own operations. #### 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 alias addresses in this page of results.

datalist of objects

An array of alias address objects.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error