Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

ex_test_ or ex_live_ key issued by an Emailx operator. Never use provider keys or session cookies.

Path Parameters

workspace_id
integer
required

Emailx workspace (Clients) ID, not the agency workspace link ID.

Required range: x >= 1

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous response. Keep filters unchanged.

status
enum<string>
Available options:
queued,
running,
succeeded,
partially_succeeded,
failed,
needs_reconciliation,
awaiting_user_action,
cancelled

Response

Success

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required