attek API
integer · min: 1 · max: 200integer · min: 0
notifications
List Inbox
GET
/api/v1/notifications
List the acting organization's own notifications, newest first, with this
person's read state. Use when showing the inbox. Answers one page (limit
rows, default 50, after offset); read on with a larger offset until a
page comes back short. Changes nothing.
query Parameters
limitDefault: 50
offsetDefault: 0
List Inbox › Responses
Successful Response
A `NotificationOut` plus the read state of the person asking — per-person,
per notifications.md:26, never shared and never part of the organization's
own record. `None` means this person has not marked it read.
audienceEnum values:
client
platform
required
required
required
event_codeidoccurred_atrequired
object · required
required
required
required
required
required
Get Unread Count
GET
/api/v1/notifications/unread-count
How many notifications in the acting organization's inbox this person has not marked read, over the whole inbox rather than one page of it. Use for a badge; read the notifications themselves with the list. Changes nothing.
Get Unread Count › Responses
200
Successful Response
How many notifications in the person's inbox they have not marked read,
across the whole inbox. Per-person, like `InboxItemOut.read_at`.
count