curl --request GET \
--url https://staging.api.us.aptlydone.com/v1/notifications \
--header 'Authorization: Bearer <token>'
{
"statusCode": 200,
"timestamp": "2025-06-24T08:51:23.644Z",
"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",
"readAt": "2023-01-02T14:30:00Z",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"entityType": "delegation",
"entityId": "123456",
"actionUrl": "https://example.com/delegations/123456",
"payload": {
"assignedBy": "John Doe",
"priority": "high"
},
"relativeTime": "2 hours ago"
}
]
}
}
curl --request GET \
--url https://staging.api.us.aptlydone.com/v1/notifications \
--header 'Authorization: Bearer <token>'
{
"statusCode": 200,
"timestamp": "2025-06-24T08:51:23.644Z",
"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",
"readAt": "2023-01-02T14:30:00Z",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"entityType": "delegation",
"entityId": "123456",
"actionUrl": "https://example.com/delegations/123456",
"payload": {
"assignedBy": "John Doe",
"priority": "high"
},
"relativeTime": "2 hours ago"
}
]
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Page number
Number of items per page
Tenant ID to filter notifications
"123e4567-e89b-12d3-a456-426614174000"
Filter by notification status
UNREAD
, READ
Filter by template key
"DELEGATION_ISSUED"
Filter by category
"Delegations"
Filter by entity type
"delegation"
Filter by time period (1m, 3m, 6m, all)
1m
, 3m
, 6m
, all
Notifications retrieved successfully
The response is of type object
.