GET
/campaignsList campaigns
Lists campaigns, with optional filters for status and tags and optional sorting controls. Use query to apply custom SQL criteria, or use page and per_page to paginate the results. Set no_body to true to request a response without body content.
statusarray<string>optional
Filter campaigns by status; accepted values are scheduled, running, paused, and cancelled. Repeat this parameter to specify multiple statuses.
no_bodybooleanoptional
Set to true to request a response without body content.
pageintegeroptional
The page number to return when paginating campaign results.
per_pageintegeroptional
The number of campaigns per page, or all to return results without pagination.
tagsarray<string>optional
Filter campaigns by tag. Repeat this parameter to specify multiple tags.
orderstringoptional
Sort direction: ASC for ascending or DESC for descending order.
order_bystringoptional
Campaign field to sort by: name, status, created_at, or updated_at.
querystringoptional
A SQL query expression for filtering campaigns by custom criteria.
200Returns campaign results in `data.results`, along with the query and pagination metadata, including total, per_page, and page.
dataobjectoptional
Error handling
status must contain values from scheduled, running, paused, or cancelled, and order must be ASC or DESC. order_by must be name, status, created_at, or updated_at; per_page accepts an integer or all. Use page and per_page to paginate the results.