v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
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_uuid filter is ignored for user-scoped keys.

Filtering

  • status defaults to pending. Pass one or more of pending, drafted, sent, dismissed, expired to widen the set. Suppressed actions are never returned.
  • owner_uuid narrows the result to a single owner (organization-level keys only).

Pagination

  • Cursor-based. Omit cursor for the first page; pass the response's next_cursor unchanged for the next. When next_cursor is absent, iteration is complete.
  • size is clamped to a server-side maximum of 200 (default 50).
get/actions

Query parameters

owner_uuidstring

Filter to a single owner user UUID. Only honored for organization-level API keys; ignored for user-scoped keys.

statusstring[]

Lifecycle statuses to include. Defaults to pending only. Suppressed actions are never returned.

cursorstring

Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.

sizeinteger

Maximum number of actions to return per page (default 50, max 200)

Response

Successfully retrieved the matching actions

next_cursorstring

Opaque cursor for the next page. Absent when there are no more results.

Example response

{
  "data": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entity_type": "account",
      "entity_id": "0018c00002ExampleAAA",
      "owner_user_uuid": "a1b2c3d4-e5f6-7a8b-9c0d-ef1234567890",
      "action_type": "send_email",
      "title": "Follow up on the renewal",
      "signal_type": "no_reply",
      "severity": "medium",
      "display_group": "Re-engage",
      "subject": "Re: renewal",
      "draft_body": "Hi Jane,\n\nFollowing up on the renewal we discussed — do the proposed terms still work on your side?\n\nBest,\nAlex",
      "proposed_recipients": [
        "jane.doe@example.com"
      ],
      "proposed_slots": [],
      "status": "pending",
      "external_url": "",
      "why": {
        "rationale": "No reply in 8 days and the opportunity's close date is this month.",
        "key_quote": {
          "text": "Let's circle back next week.",
          "speaker": "Jane Doe",
          "source_label": "Call on 2026-01-08",
          "source_url": "https://example.com/conversations/abc123"
        },
        "evidence": [
          {
            "label": "No reply in 8 days",
            "description": "Last outreach was 8 days ago with no response.",
            "impact": "negative",
            "source_label": "Email thread",
            "source_url": "https://example.com/mail/thread/123"
          }
        ]
      },
      "generated_at": "2026-01-15T09:00:00.000Z",
      "updated_at": "2026-01-15T09:00:00.000Z",
      "expires_at": "2026-01-22T09:00:00.000Z"
    }
  ],
  "next_cursor": "MjAyNi0wMS0xNVQwOTowMDowMFp8M2ZhODVmNjQtNTcxNy00NTYyLWIzZmMtMmM5NjNmNjZhZmE2"
}