Retrieve a Number Group Membership

View as Markdown

Retrieves the details of a number group membership.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

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 the number group membership.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.
number_group_idstringformat: "uuid"
The unique identifier of the Number Group this membership is associated with.
phone_numberobject
A representation of the phone number this membership is associated with.
created_atstring
The date and time when the membership was created.
updated_atstring
The date and time when the membership was last updated.

Errors