curl --request GET \
--url https://{defaultHost}/v1/apps/{app_id}/notifications \
--header 'Authorization: Bearer <token>' \
--header 'X-Authorization: <api-key>'{
"notifications": [
{
"id": "<string>",
"app_id": "<string>",
"event_type": "verification.otp.sent",
"category": "verification",
"priority": "low",
"status": "pending",
"title": "Verification Code Sent",
"body": "<string>",
"app_user_id": "<string>",
"action_url": "<string>",
"action_text": "<string>",
"requires_action": true,
"dismissible": true,
"read": true,
"read_at": "2023-11-07T05:31:56Z",
"dismissed": true,
"dismissed_at": "2023-11-07T05:31:56Z",
"expired": true,
"expires_at": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"total_pages": 123,
"total_count": 123,
"unread_count": 123
}
}Retrieve paginated list of notifications for the authenticated user
curl --request GET \
--url https://{defaultHost}/v1/apps/{app_id}/notifications \
--header 'Authorization: Bearer <token>' \
--header 'X-Authorization: <api-key>'{
"notifications": [
{
"id": "<string>",
"app_id": "<string>",
"event_type": "verification.otp.sent",
"category": "verification",
"priority": "low",
"status": "pending",
"title": "Verification Code Sent",
"body": "<string>",
"app_user_id": "<string>",
"action_url": "<string>",
"action_text": "<string>",
"requires_action": true,
"dismissible": true,
"read": true,
"read_at": "2023-11-07T05:31:56Z",
"dismissed": true,
"dismissed_at": "2023-11-07T05:31:56Z",
"expired": true,
"expires_at": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"total_pages": 123,
"total_count": 123,
"unread_count": 123
}
}API Secret token
User Access token
App ID
Page number
Items per page (default: 20)
Filter by category (e.g., security, verification, workspace)
Filter unread only (set to 'true')
Filter notifications requiring action (set to 'true')
Was this page helpful?