Get Notification Preferences
Push Notification Endpoints
Get Notification Preferences
Read the authenticated user’s disabled push notification types
Get Notification Preferences
Returns the set of notification event types the acting user has disabled for push. A user with no preference row is all-on — the response is an empty
Returned when an end-user token names a
Returned when the
Returned when a service/master key omits the required
Returned when the
Returned while the
Rate limit: 100 requests per 5 minutes per IP. Exceeding it returns
disabledTypes array.
Disabling a type only suppresses push; the in-app notification is still written.
Requires authentication. Acting-user-scoped: an end-user token (Authorization: Bearer <accessToken>) reads its own preferences. A service/master key acts on behalf of a named user via the optional userId query param — a service key without userId is rejected, and an end-user token may not name a different user. Requires the push bundle.
Query Parameters
string
The acting user whose preferences are read. Service/master keys only — a service key must pass it; an end-user token infers it from the auth token and may not name a different user.
Response
Returns200.
string[]
The event types the user has opted out of. Empty when no preferences are set (all-on). Values are drawn from the event palette.
Error Responses
No Credential — 401
No Credential — 401
Plain-text
Unauthorized, with no JSON body and no code. Returned when the
request carries no Authorization header at all.Rejected Credential — 403
Rejected Credential — 403
Plain-text
Forbidden, with no JSON body and no code. Returned when the
access token is malformed, has the wrong signature, or has expired — the
common case, since access tokens live 30 minutes. Refresh the access token
and retry.Acting As Another User — 403
Acting As Another User — 403
userId other than its own.Invalid Query — 400
Invalid Query — 400
userId query parameter is not a valid identifier.Missing User ID — 400
Missing User ID — 400
userId (it has no implicit session user).Bundle Not Installed — 403
Bundle Not Installed — 403
push bundle is not installed for this project.Bundle Provisioning — 503
Bundle Provisioning — 503
push bundle is mid-install. Retry shortly.Server Error — 500
Server Error — 500
429 with a plain-text message and no code.

