Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
campaigns

Returns a list of Campaign objects.

get/campaigns

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

namestring

Campaign name to filter by. Returns campaigns whose names contain this substring (case-insensitive).

status'DRAFT' | 'ONGOING' | 'COMPLETED' | 'STOPPED' | 'ENDED'

The current status of a campaign.

Example:ONGOING

Filter by campaign status. Status is derived from lifecycle timestamps and review progress.

created_at_afterstring date-time

Include campaigns created after this timestamp (exclusive). ISO 8601 format.

created_at_beforestring date-time

Include campaigns created before this timestamp (exclusive). ISO 8601 format.

started_at_afterstring date-time

Include campaigns started after this timestamp (exclusive). ISO 8601 format.

started_at_beforestring date-time

Include campaigns started before this timestamp (exclusive). ISO 8601 format.

ended_at_afterstring date-time

Include campaigns ended after this timestamp (exclusive). ISO 8601 format.

ended_at_beforestring date-time

Include campaigns ended before this timestamp (exclusive). ISO 8601 format.

stopped_at_afterstring date-time

Include campaigns stopped after this timestamp (exclusive). ISO 8601 format.

stopped_at_beforestring date-time

Include campaigns stopped before this timestamp (exclusive). ISO 8601 format.

Response

A list of campaigns for your organization.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "campaign_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "name": "Q3 Access Review",
      "status": "DRAFT",
      "is_template": false,
      "created_at": "2026-07-01T00:00:00Z",
      "updated_at": "2026-07-01T00:00:00Z",
      "created_by_user_id": "32acc112-21ff-4669-91c2-21e27683eaa1"
    }
  ]
}