Campaigns

List all campaigns

Returns all campaigns with pagination and filtering.

get/campaigns

Query parameters

per_pageinteger

Number of items per page.

filters[title]string

Filter by campaign title.

filters[subject]string

Filter by campaign subject.

filters[status]integer

Filter by campaign status code.

filters[updated_at]string

Filter by updated date (YYYY-MM-DD).

filters[date_from]string

Filter from date (YYYY-MM-DD).

filters[date_to]string

Filter to date (YYYY-MM-DD).

filters[id]integer

Filter by campaign ID.

sort_bystring

Column to sort results by. Allowed values: id, sent_at, changed_at, title, status.

sort_dirstring

Sort direction. Allowed values: asc, desc.

idinteger

from_namestring

from_emailstring

reply_tostring

titlestring

subjectstring

sent_atstring

recipientsinteger

statusinteger

{"stackTrail":"paths:/campaigns:get:responses:200:content:application/json:schema:items:properties:scheduled_at","oasType":"schema","type":"unknown"}

template_idinteger

archive_urlstring

No recorded changes to this endpoint across all 1 revision of this API.