v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB

Notifications

List all notifications

Retrieve a list of notifications for the authenticated team.

get/notifications

Query parameters

cursorstring nullable

Cursor for pagination, representing the last item from the previous page

Example:20

Cursor for pagination, representing the last item from the previous page

pageSizenumber

Number of notifications to return per page (1-100)

Example:20

Number of notifications to return per page (1-100)

'unread' | 'read' | 'archived'

string[]

Filter by notification status. Can be a single status or array of statuses. unread = new notifications, read = viewed but not dismissed, archived = dismissed from view

userIdstring uuid nullable

Filter notifications by specific user ID

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Filter notifications by specific user ID

priorityinteger nullable

Filter notifications by priority level (1-10)

Example:5

Filter notifications by priority level (1-10)

maxPriorityinteger nullable

Filter notifications by maximum priority level (priority <= maxPriority). Use 3 for user-facing notifications only.

Example:3

Filter notifications by maximum priority level (priority <= maxPriority). Use 3 for user-facing notifications only.

Response

Retrieve a list of notifications for the authenticated team.

Example response

{
  "data": [
    {
      "id": "b3b6e2c2-1f2a-4e3b-9c1d-2a4b6e2c21f2",
      "createdAt": "2024-04-15T09:00:00.000Z",
      "teamId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "userId": "c2d3e4f5-a6b7-8901-bcde-f23456789012",
      "type": "transactions_created",
      "priority": 3,
      "source": "system",
      "status": "unread",
      "metadata": {
        "transactionCount": 5,
        "dateRange": {
          "from": "2024-04-01",
          "to": "2024-04-15"
        }
      },
      "lastUsedAt": "2024-04-15T11:00:00.000Z"
    }
  ],
  "meta": {
    "cursor": "40",
    "hasPreviousPage": true
  }
}