Skip to main content
POST
Search enrollees

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string<uuid>
required

Campaign ID.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
status
enum<string>

Only people in this status group. See GET /v1/campaigns/enrollment-statuses.

Available options:
running,
awaiting_task,
replied,
meeting_booked,
bounced,
completed,
stopped
person_id
string<uuid>

Only enrollments of this person.

job_id
string<uuid>

Only people enrolled with this job.

batch_id
string<uuid>

Only people enrolled by this enrollment batch.

source
enum<string>

Only people enrolled through an enrollment batch from this source: api (an API key), mcp (an AI assistant connected over MCP), copilot (Ask Dex) or app (a signed-in user calling the API). People enrolled in the Stardex app have no source and are left out.

Available options:
api,
mcp,
copilot,
app
enrolled_after
string<date-time>

Only people enrolled at or after this time.

enrolled_before
string<date-time>

Only people enrolled at or before this time.

current_step
integer

Only people currently on this step, counting from 1. Only running people have a current step.

Required range: 1 <= x <= 20
reply_intent
enum<string>

Only people whose reply was read as positive (interested), neutral or negative (not interested).

Available options:
positive,
neutral,
negative
min_opens
integer

Only people who opened the emails at least this many times.

Required range: 0 <= x <= 32767
max_opens
integer

Only people who opened the emails at most this many times. 0 finds people who never opened, including bounced people.

Required range: 0 <= x <= 32767
min_clicks
integer

Only people who clicked links at least this many times.

Required range: 0 <= x <= 32767
max_clicks
integer

Only people who clicked links at most this many times. 0 finds people who never clicked.

Required range: 0 <= x <= 32767

Only people whose name or email contains this text.

Required string length: 1 - 200
sort_by
enum<string>
default:enrolled_at

Defaults to enrolled_at.

Available options:
enrolled_at,
name,
status,
next_step_at,
opens,
clicks
sort_order
enum<string>
default:desc

Defaults to desc.

Available options:
asc,
desc

Response

Enrollees found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required