List notifications

GET /v1/notifications

List notifications

cURL

curl --request GET \
  --url https://staging.api.us.aptlydone.com/v1/notifications \
  --header 'Authorization: Bearer <token>'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:08:08.311Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440002",
        "tenantId": "123e4567-e89b-12d3-a456-426614174000",
        "templateKey": "DELEGATION_ISSUED",
        "category": "Delegations",
        "title": "Delegation Issued",
        "message": "Delegation ABC123 was issued to you. Click to review.",
        "isActionable": true,
        "status": "UNREAD",
        "createdAt": "2023-01-01T12:00:00Z",
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "entityType": "delegation",
        "entityId": "123456",
        "relativeTime": "2 hours ago",
        "readAt": "2023-01-02T14:30:00Z",
        "actionUrl": "https://example.com/delegations/123456",
        "payload": {
          "assignedBy": "John Doe",
          "priority": "high"
        }
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · number · default: 1 · required

Page number

limit · number · default: 10 · required

Number of items per page

tenantId · string<uuid>

Tenant ID to filter notifications (optional, defaults to user active tenant)

Example:

"123e4567-e89b-12d3-a456-426614174000"

status · enum<string>

Filter by notification status

Available options: UNREAD, READ

templateKey · string

Filter by template key

Example:

"DELEGATION_ISSUED"

category · string

Filter by category

Example:

"Delegations"

entityType · string

Filter by entity type

Example:

"delegation"

timePeriod · enum<string> · default: all

Filter by time period (1m, 3m, 6m, all)

Available options: 1m, 3m, 6m, all

Response

200 - application/json

Notifications retrieved successfully

statusCode · number · required

Example:

200

timestamp · string · required

Example:

"2026-01-12T09:08:08.311Z"

message · string · required

Example:

"Success"

data · object

Show child attributes