REST ClientFabricSubscribers

listAddresses

View as MarkdownOpen in Claude

List addresses associated with a subscriber resource.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Subscriber Address.

Response

datalist of objectsRequired
An array of objects that contain a list of Subscriber addresses

Response Example

Response
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]

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const addresses = await client.fabric.subscribers.listAddresses("subscriber-id");
10for (const addr of addresses.data ?? []) {
11  console.log(`${addr.display_name}: ${addr.id}`);
12}