Get Subscribers

Get existing subscribers for an order

This endpoint will retrieve all existing subscribers for an order. It is required to include the client token for authorization, and the following query parameters to make the request:

  • clientUserId: The clientUserId that the subscription is listening to
  • subscriberEmail: The email that the subscription is bound to
  • role: The role that the subscription is bound to. (Available roles: producer)

Note: Parameters's values should be URL encoded



Querystring parameter values should be url encoded

GET /api/v1/subscriptions?clientUserId=<clientUserId>&subscriberEmail=<subscriberEmail>&role=<role> HTTP/1.1
Content-Type: application/json
Cache-Control: no-cache
Authorization : Bearer <your-client-token>

A successful request will yield a 200 response with an array of subscriptions to that order.

Below is a sample response:

        "subscriberFirstName": "John",
        "subscriberLastName": "Smith",
        "subscriberOffice": "nw676",
        "clientUserId": "policy_number",
        "subscriberEmail": "[email protected]",
        "id": "5318d0dd01d4d5001265c183",
        "createdAt": "2020-08-21T18:23:21.445Z",
        "role": "producer"