notifications
GET /v1/notification-preferences
What you want to hear about, by topic.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/notification-preferences \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Every topic you receive mail on, with your current answer and whether it can be changed at all. A topic you may NOT silence is still returned, with `can_opt_out: false` and a `reason` naming the duty. Dropping it would be a screen that lies by omission: you would conclude we do not email about security, switch off everything visible, and be surprised by a suspension notice. A topic nobody receives anything on is omitted entirely - offering a switch for mail that does not exist invites you to turn it off and conclude the screen is broken.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | The organization to act on. Omitted (or empty) means your own. A reseller managing a client org must name it - defaulting silently would write the reseller's own preferences whi… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | NotificationPreference[] | Yes | — |
Errors this endpoint can return
401 · 403 · 429