campaigns

get/api/campaigns

Request

  • Base URL: https://app.heykairon.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.heykairon.com/api/campaigns
  • Auth: API key in header x-api-key

Query parameters

qstring

Case-insensitive substring of the campaign's name.

string
OR
string[]

Return only campaigns in these statuses — one, or several as a comma-separated list (e.g. draft,active,paused). Omit for every status, including the finished and archived ones the app hides by default.

string
OR
string

Return only campaigns serving this initiative. The literal none returns the campaigns serving no initiative yet — the candidates an initiative can attach (PRD-79 IN8), since a campaign serves at most one.

cursorstring

Opaque keyset token from the previous page's nextCursor. Omit for the first page.

limitinteger
sort'name' | 'status' | 'sender' | 'updated'

Order the page by this column instead of the default one. The default puts the campaigns that are running first — active, then draft, then paused, then finished, then archived — and the most recent first inside each of those.

direction'asc' | 'desc'

Which way sort runs. Omit it to get the column read the way the app reads it: names and senders A→Z, statuses running-first, dates newest-first.

Changes

No recorded changes to this operation across all 6 revisions of this API.