Get Subscriber

View as Markdown

Fetch an existing Subscriber

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.

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) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Subscriber.

Response

The request has succeeded.
idstring
Unique ID of the request.
project_idstring
Unique ID of the project.
display_namestring
Display name of the Subscriber.
typeenum
Type of the resource.
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
subscriberobject
Subscriber data.

Errors