GET
/
api
/
subscriptions
Get All Subscription Information for a Resource
curl --request GET \
  --url https://api.embedreach.com/api/subscriptions
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "externalId": "<string>",
        "emailOptOut": true,
        "phoneOptOut": true,
        "emailSubscriptionChangeSource": "<string>",
        "smsSubscriptionChangeSource": "<string>",
        "emailSubscriptionChangeAt": "<string>",
        "smsSubscriptionChangeAt": "<string>",
        "lastSubscriptionChangeAt": "<string>"
      }
    ],
    "pagination": {
      "total": 123,
      "hasNextPage": true,
      "cursor": "<string>"
    }
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

​
cursor
string

The cursor to start the pagination

​
limit
number

The number of items per page

​
since
string

Since timestamp to filter lastSubscriptionChangeAt

Response

200
application/json

Status 200 response

The response is of type object.