Skip to main content
GET
/
campaigns
/
{campaignId}
/
people
List the people in a campaign (keyset-paginated, filtered)
curl --request GET \
  --url https://origami.chat/api/v2/campaigns/{campaignId}/people \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "items": [
    {
      "object": "<string>",
      "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "recipient": "<string>",
      "sendStatus": "<string>",
      "stopReason": "<string>",
      "profile": "<unknown>",
      "fitExplanation": "<string>",
      "fitScore": 123,
      "addedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>",
  "url": "<string>",
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaignId
string<uuid>
required

The campaign id (a first-class campaigns row).

Query Parameters

​
cursor
string

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

​
limit
integer
default:50

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

Required range: 1 <= x <= 100
​
search
string

Substring match over recipient / identity.

​
status
string

CSV of send-status buckets to include.

Response

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

The canonical v2 list envelope. Every list endpoint returns this shape; per-endpoint items element types (and documented extras like total) are declared on each operation.

​
object
string
required
Allowed value: "list"
​
items
object[]
required

The page of objects. Element type is per-endpoint.

​
nextCursor
string | null
required

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

​
url
string
required

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

​
total
integer
required

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