ECecomail
Campaigns

List all campaigns

Changed on

Returns all campaigns with pagination and filtering.

get/campaigns

Request

  • Base URL
    https://api2.ecomailapp.cz
  • URL
    https://api2.ecomailapp.cz/campaigns
  • Auth
    API key in header key

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.

Response

OK

idinteger
from_namestring
from_emailstring
reply_tostring
titlestring
subjectstring
sent_atstring
recipientsinteger
statusinteger
scheduled_atunknown
template_idinteger
recepient_listsinteger[]
smart_deliveryunknown
archive_urlstring

Changes

  • 463706880cfdRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status