Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Business Services

List Business Service Subscribers

Retrieve a list of Notification Subscribers on the Business Service.

<!-- theme: warning -->

Users must be added through POST /business_services/{id}/subscribers to be returned from this endpoint. Scoped OAuth requires: subscribers.read

get/business_services/{id}/subscribers

Path parameters

idstring required

The ID of the resource.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Response

OK

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

account_idstring

The ID of the account belonging to the subscriber entity

Example response

{
  "subscribers": [
    {
      "subscriber_id": "PD1234",
      "subscriber_type": "user"
    }
  ]
}