List Campaigns
Lists the campaigns of the workspace, newest first. Needs a Full key. A key limited to one domain answers 403.
Lists are paged with cursors. Read next_cursor and send it as after for the next page. A page has 50 items unless you set per_page, up to 100.
{ "data": [ { "id": "cpg_06d2mfk8r7hm4ps9wb2kd", "name": "October product update", "status": "sent", "subject": "What’s new in October", "include_segments": [ { "id": "seg_06d2mfk8r2kd7fq4mx9ab", "name": "Customers" } ], "exclude_segments": [], "topic": { "id": "top_06d2mfk8r6pn2tc8yw3hd", "name": "Product updates" }, "audience_count": 1204, "queued_count": 1204, "skipped_count": 6, "paused_reason": null, "scheduled_at": null, "started_at": "2026-10-21T09:00:00.000Z", "completed_at": "2026-10-21T09:04:12.000Z", "stats": { "delivered": 1196, "opened": 538, "clicked": 141 }, "created_at": "2026-10-20T15:30:00.000Z", "updated_at": "2026-10-21T09:04:12.000Z" } ], "prev_cursor": null, "next_cursor": null }
Returns a page of campaigns.
Query Parameters
Text to find in the name, up to 200 characters.
One status or a comma-separated list: draft, scheduled, sending, paused, failed, sent or canceled.
sent or name. By default campaigns sort by when they started, are scheduled or were created.
asc or desc. Defaults to desc.
How many items to return, from 1 to 100. Defaults to 50.
A next_cursor from the last page. Returns the items after it.
A prev_cursor from the last page. Returns the items before it. When you send both, before wins.
Response
The campaigns on this page.
Send it as before to get the page before. null on the first page.
Send it as after to get the next page. null on the last page.