Skip to content
Klaarin
Open Klaarin

Notifications

Read and manage the key’s user's own notifications. Scoped by user id alone — a notification belongs to one person regardless of which workspace they're active in, so these behave identically for every credential type and have no workspace boundary to enforce.

GET

/notifications

Lists the caller's notifications, newest first, with task/comment/project/actor summaries embedded.

Query parameters

  • unreadOnlybooleanoptionaltrue to return only unread notifications
  • limitintegeroptionalPage size, default 25, max 100
  • offsetintegeroptionalNumber of results to skip, default 0
GET

/notifications/count

Returns just the caller's unread count, for a badge.

PUT

/notifications/{id}/read

Marks one notification read and returns it. 404s — never 403 — for a nonexistent id or one belonging to someone else; the two are indistinguishable to the caller.

PUT

/notifications/read-all

Marks every one of the caller's unread notifications read.

DELETE

/notifications/{id}

Deletes one notification. Same ownership check and 404 behavior as Mark read above.

View example
List notifications
curl "https://api.klaarin.com/v1/notifications?unreadOnly=true" \
  -H "Authorization: Bearer kl_live_9f2ac…"
Response
{
  "data": [
    {
      "id": 9001,
      "type": "mention",
      "title": "You were mentioned",
      "isRead": false,
      "task": { "id": 318, "name": "Review homepage copy" },
      "actor": { "id": "clx...", "name": "Bayu Pratama", "image": null }
    }
  ],
  "meta": { "total": 6, "limit": 25, "offset": 0, "hasMore": false }
}