List Subscriber Addresses

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers/:id/addresses

GET

/api/fabric/resources/subscribers/:id/addresses

$ curl https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers/id/addresses \
>      -u "<project_id>:<api_token>"

1 [
2   {
3     "data": [
4       {
5         "id": "691af061-cd86-4893-a605-173f47afc4c2",
6         "name": "justice-league",
7         "display_name": "Justice League",
8         "cover_url": "https://coverurl.com",
9         "preview_url": "https://previewurl.com",
10         "locked": true,
11         "channels": {
12           "audio": "/external/resource_name?channel=audio"
13         },
14         "created_at": "2024-05-06T12:20:00Z",
15         "type": "subscriber"
16       }
17     ],
18     "links": {
19       "self": "https://example.signalwire.com/api/fabric/resources/subscribers/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50",
20       "first": "https://example.signalwire.com/api/fabric/resources/subscribers/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50",
21       "next": "https://example.signalwire.com/api/fabric/resources/subscribers/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
22       "prev": "https://example.signalwire.com/api/fabric/resources/subscribers/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
23     }
24   }
25 ]

Returns the project-scoped resource addresses assigned to one Subscriber. Use these callable handles to see how calls or messages can reach that subscriber; use Get Subscriber for profile data, or the SAT-authenticated List Resource Addresses from a Client when a subscriber client is discovering addresses it can reach.

Permissions

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

Learn more about API scopes.

Returns the project-scoped resource addresses assigned to one [Subscriber](/docs/platform/subscribers). Use these callable handles to see how calls or messages can reach that subscriber; use [Get Subscriber](/docs/apis/rest/subscribers/get-subscriber) for profile data, or the SAT-authenticated [List Resource Addresses from a Client](/docs/apis/rest/addresses/list-resource-addresses-client) when a subscriber client is discovering addresses it can reach. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, 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) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Subscriber Address.

Response

The request has succeeded.

datalist of objects

An array of objects that contain a list of Subscriber addresses

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error