Skip to content

List notifications​

GET
/notifications

Returns the authenticated user's notifications, newest first, together with the unread count. The count always excludes archived rows, even when archived=true is requested.
There is no offset pagination here — raise limit (max 100) to see further back.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Query Parameters

limit
Type
integer
Default
20
Maximum
100
archived

Pass "true" to return archived notifications instead of the active ones. Any other value returns the active ones.

Type
string
Valid values
"true""false"

Responses​

Notifications payload

application/json
JSON
{
"notifications": [
],
"unreadCount": 0,
"updatesUnreadCount": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress