Skip to main content
GET
/
v1
/
apps
/
{app_id}
/
notifications
List notifications
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
  }
}

Authorizations

Authorization
string
header
required

API Secret token

X-Authorization
string
header
required

User Access token

Path Parameters

app_id
string
required

App ID

Query Parameters

page
integer

Page number

per_page
integer

Items per page (default: 20)

category
string

Filter by category (e.g., security, verification, workspace)

unread
string

Filter unread only (set to 'true')

requires_action
string

Filter notifications requiring action (set to 'true')

Response

successful

notifications
object[]
meta
object