Skip to navigation

Read the caller's notification preferences

Category toggles, quiet hours and the timezone they are evaluated in, plus available_categories so a settings screen renders server-owned labels. A user who has never changed anything gets the defaults. A push that falls in quiet hours is dropped, not delivered later.

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Response

The caller's preferences.
categoriesmap from strings to booleansOptional

Every category, keyed by NotificationCategory, with its effective setting — the user's choice, or the default.

quiet_hours_enabledbooleanOptional
quiet_hours_startstring or nullOptionalformat: "^[0-2][0-9]:[0-5][0-9]$"

Local time in timezone, 24-hour HH:MM.

quiet_hours_endstring or nullOptionalformat: "^[0-2][0-9]:[0-5][0-9]$"

Local time in timezone. Earlier than the start means the window wraps midnight.

timezonestringOptional
IANA zone quiet hours are evaluated in. Empty until a device reports one or the user chooses one.
timezone_sourceenumOptional

device — the latest zone a registered install reported. user — chosen explicitly; device reports never overwrite it. Empty when no zone is known.

Allowed values:
updated_atdatetime or nullOptional
available_categorieslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error