List notifications

GET

/notifications

GET

/notifications

1 curl https:/https://api/notifications \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "notifications": [
3     {
4       "id": "notif_8f3b2a1c",
5       "type": "task_assigned",
6       "title": "New Task Assigned",
7       "message": "You have been assigned to the task 'Prepare Q2 Report'.",
8       "createdAt": "2024-06-10T09:15:00Z",
9       "read": false,
10       "taskId": "task_4d2e1f9b"
11     },
12     {
13       "id": "notif_7a1c3d4e",
14       "type": "comment_mention",
15       "title": "Mentioned in Comment",
16       "message": "Alice mentioned you in a comment on 'Project Roadmap'.",
17       "createdAt": "2024-06-09T16:45:00Z",
18       "read": true,
19       "commentId": "comment_9f8e7d6c"
20     }
21   ],
22   "nextCursor": "eyJwYWdlIjoyfQ=="
23 }

Returns the caller’s notifications (newest first) with a pagination cursor. Scoped to the caller’s own user id.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Query parameters

limitintegerOptional

cursorstringOptional

unreadOnlybooleanOptional

Response

The caller's notifications and next cursor.

notificationslist of maps from strings to any

nextCursorstring or null

Errors

401

Unauthorized Error