Skip to content

Read personal notification preferences

GET
/v1/admin/me/notifications

Clerk identity only. Preferences and devices belong to the person across all current and future organizations. Agent credentials are not accepted. Request bodies are limited to 16 KB. Responses use private, no-store caching.

Success

object
preferences
required
object
grouping_minutes
required
integer
default: 5
Allowed values: 1 5 15
version
required
integer
categories
required
Array<object>
object
id
required
string
Allowed values: review purchase_approval purchase_completed purchase_problem domain_progress domain_action domain_ready domain_problem sending_problem
label
required
string
description
required
string
push
required
boolean
email
required
boolean
email
required
string
email_status
required
string
Allowed values: verified unavailable
push_available
required
boolean

Invalid bounded request

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean

Resource not owned or currently accessible

Version conflict

Test rate limit exceeded

Notification dependency unavailable