Skip to main content
POST
notify.subscriber.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
subscriberId
string
required

Your own subscriber identifier, scoped to your connected account.

Required string length: 1 - 200
includeContacts
boolean
default:false

Include the subscriber email and phone.

Response

The result

subscriberId
string
required

Your own subscriber identifier.

firstName
string

Subscriber first name.

lastName
string

Subscriber last name.

name
string

Subscriber display name.

locale
string

Subscriber locale.

timezone
string

Subscriber time zone.

email
string

Subscriber email, only when contacts are requested.

phone
string

Subscriber phone, only when contacts are requested.