Skip to content

Notifications Endpoints

Notification endpoints require the notifications scope.

GET /api/v1/notifications

Scope: notifications

ParameterTypeDefaultDescription
limitinteger20Max 100
cursorstringPagination cursor
unreadstringSet to true to only return unread notifications
{
"data": {
"notifications": [
{
"id": "notif-uuid",
"type": "slot.submitted",
"title": "New submission",
"body": "TestGamer42 submitted a playtest for Dungeon Crawlers",
"readAt": null,
"createdAt": "2026-03-01T16:00:00.000Z"
}
],
"unreadCount": 5
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2026-03-02T12:00:00.000Z",
"cursor": "eyJpZCI6ImFiYzEyMyJ9",
"hasMore": false
}
}

readAt is null for unread notifications, or an ISO timestamp for when it was read. unreadCount is the total number of unread notifications (regardless of pagination).


POST /api/v1/notifications/mark-all-read

Scope: notifications

Marks all unread notifications as read.

{
"data": {
"message": "All notifications marked as read",
"updatedCount": 5
},
"meta": {
"requestId": "req_abc123def456",
"timestamp": "2026-03-02T12:00:00.000Z"
}
}