Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string<uuid>
required

The unique id of the campaign

Query Parameters

status
enum<string>

Only entries in this status.

Available options:
pending,
failed_validation,
dispatched,
completed
sort_by
enum<string>
default:created_at

Sort field.

Available options:
created_at,
reference_id,
status
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
limit
integer
default:20

Number of results per page.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip.

Required range: x >= 0

Response

Paginated list of entries

items
object[]
required
total
integer
required
limit
integer
offset
integer