Skip to main content
GET
/
campaigns
curl 'https://api2.ecomailapp.cz/campaigns?sort_by=sent_at&sort_dir=desc' \
  -H "key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

[
  {
    "id": 1,
    "from_name": "From name",
    "from_email": "from@foo.cz",
    "reply_to": "reply@bar.cz",
    "title": "My first campaign",
    "subject": "First hello",
    "sent_at": "2014-09-08 22:04:03",
    "recipients": 1,
    "status": 3,
    "scheduled_at": null,
    "template_id": 62,
    "archive_url": "https://foo.ecomailapp.cz/campaigns/render/1/randomhashhere"
  }
]
Campaign status codes:
  • 0 — Draft
  • 1 — Preparing
  • 2 — Sending
  • 3 — Sent
  • 4 — Errored
  • 7 — Scheduled
​
per_page
integer
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_by
string
default:"id"
Column to sort results by. Allowed values: id, sent_at, changed_at, title, status.
​
sort_dir
string
default:"desc"
Sort direction. Allowed values: asc, desc.
curl 'https://api2.ecomailapp.cz/campaigns?sort_by=sent_at&sort_dir=desc' \
  -H "key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

[
  {
    "id": 1,
    "from_name": "From name",
    "from_email": "from@foo.cz",
    "reply_to": "reply@bar.cz",
    "title": "My first campaign",
    "subject": "First hello",
    "sent_at": "2014-09-08 22:04:03",
    "recipients": 1,
    "status": 3,
    "scheduled_at": null,
    "template_id": 62,
    "archive_url": "https://foo.ecomailapp.cz/campaigns/render/1/randomhashhere"
  }
]