List user notifications

Notifications

Description

Retrieve a paginated list of notifications for the authenticated user.
Returns notifications ordered by most recent first.

Authentication Required: User must be authenticated.

Parameters

page integer query

Page number for pagination (defaults to 1)

has_been_read boolean query

Filter by read status (true for read, false for unread)

Accept-Language string header

Locale for message translation. Defaults to English if omitted. Supported values are en, fr, and es.

Responses

200 Successful response with paginated notifications

application/json

statusstring

Example: success

dataarray

current_pageinteger

Example: 1

total_resultsinteger

Example: 45

total_pagesinteger

Example: 2

Example:

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "event": "new_transaction",
      "context": {
        "amount": "150.00"
      },
      "message": "A new transaction of $150.00 was recorded",
      "has_been_read": false,
      "notified_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "event": "payout_received",
      "context": {
        "amount": "500.00"
      },
      "message": "You received a payout of $500.00",
      "has_been_read": true,
      "notified_at": "2024-01-14T14:20:00Z"
    }
  ],
  "current_page": 1,
  "total_results": 45,
  "total_pages": 2
}

401 Authentication required

application/json

Example:

{
  "status": "error",
  "message": "Not authenticated or insufficient permissions"
}

404 Page not found

application/json

Example:

{
  "status": "error",
  "message": "Page not found"
}