Skip to main content
GET
Returns a paginated list of campaigns for the project.

Authentication

X-API-Key
string
required
Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id
string
required
Organization ID. Must match the API key.
project_id
string
required
Project ID. Must match the API key.

Query parameters

skip
integer
default:"0"
Number of records to skip. Must be >= 0.
limit
integer
default:"20"
Page size. Range: 1100.
filters
string
JSON object of MongoDB-compatible filters, for example {"status":"running"}.
sort
string
JSON sort object, for example {"created_at":-1}. Defaults to created_at descending.
projection
string
JSON projection object or comma-separated field list.

Response

items
array
required
Campaign objects for the current page.
pagination
object
required
Pagination metadata.

Errors

401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
API key is not authorized for this organization or project.