Notify API reference

Notify API · Recipients

get/v1/workspaces/{workspace_id}/recipients/{external_id}/timelineAuth

Get a recipient's delivery timeline

Every delivery to this recipient across notifications, newest first, with the reason for each skip or failure, the device's state and its last successful delivery; the first page also lists device token moves in and out of the recipient.

Path parameters

workspace_id*string · uuid

Id of the workspace.

external_id*string

Your user id for the recipient (URL-encoded): 1-255 of `A-Z a-z 0-9 . _ : @ | -`.

Query parameters

cursorstring

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

limitinteger

Page size.

Response · 200 A page of the timeline.

data*array

Every delivery to the recipient, newest first.

pagination*object

The cursor for the next page.

device_moves*array

Device token moves in or out of this recipient (latest first, at most 50).

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/recipients/{external_id}/timeline
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "notification_id": "00000000-0000-0000-0000-000000000000",
      "recipient_id": "00000000-0000-0000-0000-000000000000",
      "recipient_external_id": "string",
      "channel": {},
      "provider": "string",
      "device_id": "00000000-0000-0000-0000-000000000000",
      "target": "string",
      "fallback_step": 0,
      "is_fallback": false,
      "state": {},
      "reason": {},
      "explanation": "string",
      "attempts": 0,
      "next_attempt_at": "2026-01-01T00:00:00.000Z",
      "provider_message_id": "string",
      "provider_unique_id": "string",
      "rendered": {},
      "warnings": [
        "string"
      ],
      "sent_at": "2026-01-01T00:00:00.000Z",
      "final_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "type": "string",
      "device": {}
    }
  ],
  "pagination": {},
  "device_moves": [
    {
      "device_id": "00000000-0000-0000-0000-000000000000",
      "channel": "string",
      "direction": {},
      "moved_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}