Campaigns
List campaigns
Get a paginated list of email campaigns.
This endpoint uses offset pagination (page / pageSize), not the cursor pagination used by GET /contacts.
get/campaigns
Query parameters
pageinteger
1-based page number.
pageSizeinteger
Items per page.
status'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED'
Filter by campaign status. An unrecognised value returns 400.
searchstring
Case-insensitive match on name, subject, or sender address.
sort'name' | 'createdAt' | 'updatedAt'
Column to sort by. Unrecognised values fall back to createdAt.
dir'asc' | 'desc'
Sort direction. Unrecognised values fall back to the default.
Response
List of campaigns