List the caller's notification inbox

Returns an envelope, not a bare array: {"items": [...], "nextBefore": "<RFC3339Nano>" | null}. See NotificationList for why nextBefore (not the last item's createdAt) is the cursor to pass back.

get/me/notifications

Request

  • Base URL: https://craaft.io/api/v1
  • URL: https://craaft.io/api/v1/me/notifications
  • Auth: HTTP bearer

Query parameters

beforestring date-time

RFC3339Nano cursor. Returns notifications older than this timestamp - pass back the previous page's nextBefore.

limitinteger

Raw rows fetched before grouping. Default 30, clamped to 50. The returned items array can be shorter once unread rows on the same card are grouped.

unread'1'

Set to 1 to return only unread rows.

Response

OK

nextBeforestring date-time nullable required

Cursor for the next page - pass back as ?before=. Null when there's nothing older to fetch. This is the createdAt of the OLDEST raw notification fetched for this page, before grouping - grouping can make a page hold fewer than limit items, so the last item's createdAt is NOT a usable cursor (it can be a group's newest member, and re-fetching from it would re-show rows already returned).

Changes

No recorded changes to this operation across all 2 revisions of this API.