v2

latestOpenAPI 3.0.3Apache 2.02026-07-3149289180.2 KB

Get Notifications

Get the authenticated account's notifications, newest first.

Results come in pages. Pass the cursor returned by the previous page to fetch the next, older one. If your WebSocket connection dropped or you received a resync frame, pass since_seq to backfill anything you may have missed; the same notification can show up again at the edges of the window, so deduplicate by id. While paging through a backfill, keep sending the same since_seq with each cursor so every page stays inside the same window.

The response also includes your unread count and durable_source_seq, which tells you how far the notification store has caught up. If a backfill has not yet reached your target sequence, wait briefly and retry with the same since_seq.

get/v1/account/notifications

Query parameters

cursorstring nullable

Opaque pagination cursor. Pass the next_cursor value from the previous page to fetch the next, older page. Null when there are no more pages.

Example:eyJ0cyI6MTc2NzIyNTYwMDAwMCwiaWQiOiIwYTVkOGYxZS0zYjJjLTVlNGEtOWY4Yi0xYzJkM2U0ZjVhNmIifQ

since_seqinteger

Backfill anchor for gap recovery. Pass the sequence number (sq) of the last notifications data frame you processed before the gap, never the sq of a resync frame. The bound is inclusive, so the response repeats the boundary event in full; deduplicate by notification id.

Example:1043

limitinteger

Maximum number of entries to return

Example:100

Response

Notifications page.

unreadinteger required

Count of the authenticated owner's unread notifications within the retention window.

durable_source_seqinteger required

Highest notification sequence the store has persisted for your account. If it is still below the sequence you are catching up to, the store is lagging; retry the backfill until it catches up.

has_moreboolean required

Whether older notifications exist beyond this page.

next_cursorstring nullable required

Opaque pagination cursor. Pass the next_cursor value from the previous page to fetch the next, older page. Null when there are no more pages.

Example response

{
  "items": [
    {
      "read_at": 1767225600000,
      "ts": 1767225600000
    }
  ],
  "unread": 3,
  "durable_source_seq": 1043,
  "next_cursor": "eyJ0cyI6MTc2NzIyNTYwMDAwMCwiaWQiOiIwYTVkOGYxZS0zYjJjLTVlNGEtOWY4Yi0xYzJkM2U0ZjVhNmIifQ"
}