List Campaigns

Fetch a paginated list of campaigns with optional filters.

Pagination parameters (passed as query params):

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.

statusstring nullable

Filter by status

sourcestring nullable

Filter by source

tagsstring[] nullable

Filter by tags (format: key:value)

campaignTypestring nullable

Filter by campaign type

groupIdstring nullable

Filter by group ID

runNumberinteger nullable

Filter by run number

is_deletedboolean

When true, return only soft-deleted campaigns

sizeinteger

Number of items per page

pageinteger

Page number

searchstring nullable

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Response

Paginated list of campaigns

messagestring required

Result description

totalCountinteger required

Total number of campaigns matching the applied filters

pageinteger required

Current page number (1-indexed)

sizeinteger required

Number of items returned on this page

{
  "message": "Campaigns fetched successfully."
}