Skip to content
campaign

List the org's email jobs (newest first)

GET
/v1/campaign/email
curl --request GET \
--url https://aggregator.example.com/v1/campaign/email \
--header 'Authorization: Bearer <token>'

Returns the requesting org’s email jobs, newest first, with derived status counts. Cursor pagination — pass the returned next_cursor to page.

limit
integer
>= 1 <= 100
cursor
string

Default Response

Media typeapplication/json
object
jobs
required
Array<object>
object
job_id
required
string format: uuid
channel
required
string
Allowed values: export email voice
status
required
string
Allowed values: queued processing partial completed failed
counts
required
object
total
required
integer
pending
required
integer
resolved
required
integer
submitted
required
integer
sent
required
integer
skipped_not_owned
required
integer
skipped_no_contact
required
integer
duplicate_active
required
integer
failed
required
integer
created_at
required
string
updated_at
required
string
next_cursor
required
string
nullable
Example
{
"jobs": [
{
"channel": "export",
"status": "queued"
}
]
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}