Skip to main content
GET
/
api
/
notifications
Get notifications for the logged-in user
curl --request GET \
  --url https://your-instance.example.com/api/notifications \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "66e0a0b0c0d0e0f0a0b0c0d0",
    "title": "Cory Tan mentioned you",
    "message": "@alice please review this lead",
    "category": "mention",
    "createdAt": "2026-05-18T14:30:00.000Z",
    "status": "unread",
    "notificationType": "mention",
    "contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
    "contactName": "Jane Doe",
    "phoneNumber": "+14155550123"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Notifications list (raw array, not enveloped)

​
id
string
required
​
title
string
​
message
string
​
category
string
​
createdAt
string<date-time>
​
status
string

Per-user status from User.notifications[].status (defaults to unread).

​
notificationType
string

e.g. mention, assignment, other.

​
contactId
string | null
​
contactName
string | null
​
phoneNumber
string | null
​
userId
string | null
​
mentionedBy
string | null
​
campaignId
string | null
​
messageId
string | null
Example:
[
  {
    "id": "66e0a0b0c0d0e0f0a0b0c0d0",
    "title": "Cory Tan mentioned you",
    "message": "@alice please review this lead",
    "category": "mention",
    "createdAt": "2026-05-18T14:30:00.000Z",
    "status": "unread",
    "notificationType": "mention",
    "contactId": "65c2d0e0f0a0b0c0d0e0f0a0",
    "contactName": "Jane Doe",
    "phoneNumber": "+14155550123"
  }
]