List notifications for a user

GET

/domains/{domain}/users/{user}/notifications

Last modified:2026-10-12 18:08:01

OperationId:ListNotifications

Returns the user's notification feed, newest first, with the per-viewer read state on each row. The feed is the union of the user's own rows, the domain's shared rows, the platform global rows, and (only when the caller holds an administrator scope) the admin-scoped rows. Requires a token with scope_priv on the notification object. A caller who is not the target user and does not hold Office Manager, Call Center Supervisor, Super User, or Reseller scope receives a 403 and may read only their own feed. Expired rows and rows the user has hidden are omitted. Muted categories are omitted unless include_muted=true is sent.

Request

Path Params

Query Params

Responses

🟢200

application/json

The notification feed with counts.

Bodyapplication/json

🟠400Err400

🟠401Err401

🟠403Err403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/domains/acme.example.com/users/1001/notifications?unread=true&audience=personal&include_muted=false&limit=50&offset=0'

Response Example

200 - Success Example

{
    "notifications": [
        {
            "id": 84213,
            "domain": "example.com",
            "user": "1001",
            "scope": "user",
            "category": "voicemail",
            "source_type": "vmail_forward",
            "source_id": "vm-2026-0901-0007",
            "dedupe_key": "voicemail:example.com:1001:vmail_forward:vm-2026-0901-0007",
            "severity": "info",
            "title": "New voicemail from +1 555-555-0123",
            "body": "Duration 0:42. Transcription available.",
            "payload": {
                "callid": "20260901143000-abc123",
                "duration": 42
            },
            "created_at": "2026-09-01T14:30:00Z",
            "expires_at": null,
            "is_read": false
        },
        {
            "id": 84190,
            "domain": "example.com",
            "user": "*",
            "scope": "domain",
            "category": "shared_contact",
            "source_type": "contact",
            "source_id": "pb-55012",
            "dedupe_key": "shared_contact:example.com:*:contact:pb-55012",
            "severity": "info",
            "title": "New shared contact added",
            "body": null,
            "payload": {
                "contact_id": "pb-55012"
            },
            "created_at": "2026-09-01T13:05:00Z",
            "expires_at": null,
            "is_read": true
        }
    ],
    "unread": 1,
    "total": 2,
    "limit": 50,
    "offset": 0,
    "audience": "all"
}

Modified at 2026-10-12 18:08:01

Mark notice seen

Mark notification read