List Campaigns
Campaigns
List Campaigns
Fetch a paginated list of campaigns with optional filters.
Pagination parameters (passed as query params):
- page: Page number, 1-indexed (default: 1).
- size: Items per page, max 200 (default: 50).
- search: Search term matched against campaign name.
- start / end: ISO 8601 date range filter on campaign creation date.
Filter parameters:
- status: Filter by campaign status. Possible values: pending, processing, paused, aborted, completed.
- source: Filter by campaign source (e.g. ‘internal’, ‘api’).
- tags: Repeat to filter by multiple tags:
?tags=region:west&tags=priority:high. - campaignType: Filter by campaign type (‘single’ or ‘multi’).
- groupId: Return only campaigns belonging to the specified group.
- runNumber: Return only the campaign with this run number within its group.
GET
List Campaigns
Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Query Parameters
Filter by status
Filter by source
Filter by tags (format: key:value)
Filter by campaign type
Filter by group ID
Filter by run number
When true, return only soft-deleted campaigns
Number of items per page
Required range:
x >= 1Page number
Required range:
x >= 1Search keywords
Filter by start time (ISO 8601 format)
Filter by end time (ISO 8601 format)
Response
Paginated list of campaigns