Skip to main content
GET
List recipients & engagement

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

blastId
string<uuid>
required

Blast ID.

Query Parameters

category
enum<string>
default:recipients

Engagement category to select.

Available options:
recipients,
sent,
delivered,
opened,
clicked,
bounced,
unsubscribed,
spam
page
integer
default:1

Page number, starting at 1. Page number (1-based).

Required range: x >= 1
limit
integer
default:25

Results per page (1–100). Page size.

Required range: 1 <= x <= 100

Case-insensitive name search.

Maximum string length: 255
sort
enum<string>
default:created_at

Sort key. Contacts without the event sort last.

Available options:
display_name,
email,
created_at,
sent_at,
delivered_at,
opened_at,
clicked_at,
bounced_at,
unsubscribed_at,
complained_at
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

A page of contacts.

contacts
object[]
required

Contacts in this page.

pagination
object
required

Offset pagination metadata.