Notify API reference

Notify API · Client

get/v1/client/inboxAuth

List the inbox

The recipient's in-app inbox, newest first, with the unseen and unread counts for the badge. Active items by default; `archived=true` lists the archived ones. Items the sender retracted are left out.

Query parameters

statusenum (3)

`all`, or only `unread` or `unseen` items.

categorystring

Only this category (its key).

tenantstring

Only this tenant (the `tenant` of the send).

archivedboolean

`true` lists archived items instead of the active ones.

cursorstring

Opaque cursor for pagination: the `next_cursor` of the previous page.

limitinteger

Page size.

Response · 200 A page of items.

data*array

Items, newest first. Items the sender retracted are left out.

pagination*object

The cursor for the next page.

counts*object

The recipient's unseen and unread counts (badge).

Example

Request

GET https://api.notify.productcraft.co/v1/client/inbox
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "notification_id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "category": "string",
      "tenant": "string",
      "title": "string",
      "body": "string",
      "action_url": "string",
      "avatar_url": "string",
      "actions": [
        {
          "label": "string",
          "url": "string",
          "action_key": "string"
        }
      ],
      "actor": {},
      "data": {},
      "seen_at": "2026-01-01T00:00:00.000Z",
      "read_at": "2026-01-01T00:00:00.000Z",
      "archived_at": "2026-01-01T00:00:00.000Z",
      "interacted_at": "2026-01-01T00:00:00.000Z",
      "interaction_key": "string",
      "retracted_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {},
  "counts": {}
}