List Actions
Proactive
List Actions
Lists Proactive actions (Next Best Actions), mirroring the action feed users see in the UI.
Scope
- An organization-level API key returns actions for every user in the organization.
- A user-scoped API key returns only that user’s actions; the
owner_uuidfilter is ignored for user-scoped keys.
Filtering
statusdefaults topending. Pass one or more ofpending,drafted,sent,dismissed,expiredto widen the set. Suppressed actions are never returned.owner_uuidnarrows the result to a single owner (organization-level keys only).
Pagination
- Cursor-based. Omit
cursorfor the first page; pass the response’snext_cursorunchanged for the next. Whennext_cursoris absent, iteration is complete. sizeis clamped to a server-side maximum of 200 (default 50).
GET
List Actions
Authorizations
Query Parameters
Filter to a single owner user UUID. Only honored for organization-level API keys; ignored for user-scoped keys.
Lifecycle statuses to include. Defaults to pending only. Suppressed actions are never returned.
Available options:
pending, drafted, sent, dismissed, expired Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
Maximum number of actions to return per page (default 50, max 200)
Required range:
1 <= x <= 200