Skip to main content
GET
Error

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