get

Retrieve a single subscriber resource.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Subscriber.

Response

idstringRequired

Unique ID of the request.

project_idstringRequired

Unique ID of the project.

display_namestringRequired

Display name of the Subscriber.

typeenumRequired

Type of the resource.

Allowed values:

created_atdatetimeRequired

Date and time when the resource was created.

updated_atdatetimeRequired

Date and time when the resource was updated.

subscriberobjectRequired

Subscriber data.

Response Example

Response

1 {
2   "id": "d369a402-7b43-4512-8735-9d5e1f387814",
3   "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
4   "display_name": "John Doe",
5   "type": "subscriber",
6   "created_at": "2024-05-06T12:20:00Z",
7   "updated_at": "2024-05-06T12:20:00Z",
8   "subscriber": {
9     "id": "d369a402-7b43-4512-8735-9d5e1f387814",
10     "email": "johndoe@example.com",
11     "first_name": "John",
12     "last_name": "Doe",
13     "display_name": "John Doe",
14     "job_title": "Software Engineer",
15     "timezone": "America/New_York",
16     "country": "United States",
17     "company_name": "SignalWire"
18   }
19 }

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const subscriber = await client.fabric.subscribers.get("subscriber-id");
10 console.log("Subscriber:", subscriber.display_name, "ID:", subscriber.id);

1	{
2	"id": "d369a402-7b43-4512-8735-9d5e1f387814",
3	"project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
4	"display_name": "John Doe",
5	"type": "subscriber",
6	"created_at": "2024-05-06T12:20:00Z",
7	"updated_at": "2024-05-06T12:20:00Z",
8	"subscriber": {
9	"id": "d369a402-7b43-4512-8735-9d5e1f387814",
10	"email": "johndoe@example.com",
11	"first_name": "John",
12	"last_name": "Doe",
13	"display_name": "John Doe",
14	"job_title": "Software Engineer",
15	"timezone": "America/New_York",
16	"country": "United States",
17	"company_name": "SignalWire"
18	}
19	}

1	import { RestClient } from "@signalwire/sdk";
2
3	const client = new RestClient({
4	project: "your-project-id",
5	token: "your-api-token",
6	host: "your-space.signalwire.com"
7	});
8
9	const subscriber = await client.fabric.subscribers.get("subscriber-id");
10	console.log("Subscriber:", subscriber.display_name, "ID:", subscriber.id);