Skip to main content
GET
/
api
/
email
/
campaign
Get all campaigns
curl --request GET \
  --url https://api-{region}-{cluster}.benchmarkemail.com/api/email/campaign \
  --header 'X-API-Key: <api-key>'
{
  "records": [
    {
      "_id": "<string>",
      "cancelledAt": "<string>",
      "createdAt": "<string>",
      "failedCount": 123,
      "from": "<string>",
      "name": "<string>",
      "previewImageUrl": "<string>",
      "previewText": "<string>",
      "scheduledAt": "<string>",
      "sentCount": 123,
      "stats": {
        "clicks": {
          "rate": 15.75,
          "unique": 145
        },
        "delivered": 599,
        "opens": {
          "rate": 25.35,
          "unique": 255
        },
        "sent": 650
      },
      "status": "<string>",
      "subStatus": null,
      "subject": "<string>",
      "totalRecipients": 123,
      "updatedAt": "<string>"
    }
  ],
  "total": 123
}

Authorizations

​
X-API-Key
string
header
required

API key authentication

Query Parameters

​
page
integer

page number

Required range: x >= 1
​
size
integer

page size

Required range: x >= 1
​
statuses
enum<string>
Available options:
scheduled,
sent,
draft,
sending,
paused,
failed,
cancelled
​
sort
string

Sorting parameter with the format 'field:direction'. Supported fields: name, createdAt, updatedAt, scheduledAt.

Pattern: ^[a-zA-Z0-9_]+:(asc|desc)$
​
criteria
string

A string used to filter the search results. The maximum length is 50 characters.

Maximum string length: 50

Response

Successfully retrieved

​
records
object[]
​
total
number

Total number of campaigns