ORorigami
Campaigns

List the people in a campaign (keyset-paginated, filtered)

Changed on

The people enrolled in the campaign: one row per enrolled sequence (recipient), with send status, fit score / explanation, and identity profile. Keyset-paginated via an opaque cursor; the list envelope additionally carries a top-level total. GET /campaigns/{campaignId}/sequences is a synonym (same shape); in the campaign model a person IS a sequence.

get/campaigns/{campaignId}/people

Request

  • Base URL
    https://origami.chat/api/v2
  • URL
    https://origami.chat/api/v2/campaigns/{campaignId}/people
  • Auth
    HTTP bearer

Query parameters

cursorstring

Opaque pagination cursor. Pass the nextCursor from the previous page to fetch the next one; omit for the first page.

limitinteger

Max objects to return per page. Default 50, max 100 (the rows endpoint allows up to 200 and documents its own limit).

searchstring

Substring match over recipient / identity.

statusstring

CSV of send-status buckets to include.

Response

A page of campaign people in the list envelope (with top-level total).

object'list' required
nextCursorstring nullable required

Cursor for the next page; null means this is the last page.

urlstring required

The path this list was fetched from (query string excluded).

totalinteger required

Total enrolled people matching the filters (across all pages).

Changes

  • 8c6b16fe0a3bRevision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status