Docs

GET /notifications/preferences

Which channels each notification type uses. A type with no stored row is on for both.

Parameters

This operation takes no parameters.

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
preferencesarray<object>yes
preferences[].emailbooleanyes
preferences[].in_appbooleanyes
preferences[].type"budget_exhausted" | "kill_switch_engaged" | "approvals_pending" | "trust_state_changed" | "webhook_endpoint_disabled" | "domain_verification_lost" | …yes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.