Subscribers

Get Subscriber

Retrieves one Subscriber resource by ID. Use it to inspect a known user's profile and resource metadata; use List Subscribers to discover IDs, or the Subscriber Token endpoints to create client access rather than read the profile.

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.

get/api/fabric/resources/subscribers/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/subscribers/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Subscriber.

Response

The request has succeeded.

idstring required

Unique ID of the request.

project_idstring required

Unique ID of the project.

display_namestring required

Display name of the Subscriber.

type'subscriber' required

Type of the resource.

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "project_id": "d369a402-7b43-4512-8735-9d5e1f387814",
  "display_name": "John Doe",
  "type": "subscriber",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "subscriber": {
    "email": "johndoe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "display_name": "John Doe",
    "job_title": "Software Engineer",
    "timezone": "America/New_York",
    "country": "United States",
    "company_name": "SignalWire"
  }
}

Changes

No operation changes found yet. Some revisions have not been checked.