get_notifications
Read in-app notifications for the authenticated platform user. Default lists unread items with id, title, and meta (truncated true); all=true returns every item and every field. Pass notificationId for one notification including meta (e.g. formSubmissionId on form replies), or unreadCountOnly=true for just the unread count.
get_notifications · Group: notifications
Read in-app notifications for the authenticated platform user. Default lists unread items with id, title, and meta (truncated true); all=true returns every item and every field. Pass notificationId for one notification including meta (e.g. formSubmissionId on form replies), or unreadCountOnly=true for just the unread count.
Inputs
| Field | Required | Notes |
|---|---|---|
notificationId | optional | uuid — Read one notification by id |
unreadCountOnly | optional | boolean — Return only the unread count |
unreadOnly | optional | boolean — When true, only unread notifications |
all | optional | boolean — Return every notification and every field |
websiteId | optional | uuid — Optional website filter |
limit | optional | number 1-100 — Max rows (default 50) |
fields | optional | Comma-separated response keys |
Maps to
GET /api/v1/{locale}/platform/notifications→ APIGET /api/v1/{locale}/platform/notifications/{id}→ APIGET /api/v1/{locale}/platform/notifications/unread-count→ API