REST ClientFabricSubscribers

list

View as MarkdownOpen in Claude

List subscriber resources in the project.

Response

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

Response Example

Response
1{
2  "data": [
3    {
4      "id": "d369a402-7b43-4512-8735-9d5e1f387814",
5      "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
6      "display_name": "John Doe",
7      "type": "subscriber",
8      "created_at": "2024-05-06T12:20:00Z",
9      "updated_at": "2024-05-06T12:20:00Z",
10      "subscriber": {
11        "id": "d369a402-7b43-4512-8735-9d5e1f387814",
12        "email": "johndoe@example.com",
13        "first_name": "John",
14        "last_name": "Doe",
15        "display_name": "John Doe",
16        "job_title": "Software Engineer",
17        "timezone": "America/New_York",
18        "country": "United States",
19        "company_name": "SignalWire"
20      }
21    }
22  ],
23  "links": {
24    "self": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
25    "first": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50",
26    "next": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
27    "prev": "https://example.signalwire.com/api/fabric/resources/subscribers?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
28  }
29}

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 response = await client.fabric.subscribers.list();
10for (const subscriber of response.data ?? []) {
11  console.log(`${subscriber.display_name}: ${subscriber.id}`);
12}