Skip to main content
GET
/
api
/
subscriptions
/
{externalId}
Get Subscription by External ID
curl --request GET \
  --url https://api.embedreach.com/api/subscriptions/{externalId}
{
  "success": true,
  "message": "<string>",
  "data": {
    "externalId": "<string>",
    "emailOptOut": true,
    "phoneOptOut": true,
    "emailSubscriptionChangeSource": "<string>",
    "smsSubscriptionChangeSource": "<string>",
    "emailSubscriptionChangeAt": "<string>",
    "smsSubscriptionChangeAt": "<string>",
    "lastSubscriptionChangeAt": "<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.

Path Parameters

externalId
string
required

The external ID of the user

Response

Status 200 response

success
boolean
required
message
string
data
object