Skip to main content
GET
List event invitees

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

eventId
integer
required

Record ID in the authenticated organization.

Example:

42

Query Parameters

page
integer

One-based page.

Required range: x >= 1
Example:

1

per_page
integer

Rows per page; default 50.

Required range: 1 <= x <= 100
Example:

50

Search donor names, organization, email and username.

Maximum string length: 255
Example:

"Jane"

stage
enum<string>

Computed outreach stage; confirmed attendance takes precedence over invitation disposition.

Available options:
to_invite,
in_progress,
awaiting_rsvp,
plans_to_attend,
maybe,
needs_follow_up,
confirmed,
declined,
closed
Example:

"to_invite"

owner_user_id
integer

Filter to this staff owner.

Required range: x >= 1
Example:

42

plan_state
enum<string>

Computed visible plan state.

Available options:
none,
not_started,
in_progress,
complete,
missing_task
Example:

"none"

method
enum<string>

Invitation contact method.

Available options:
phone_call,
text_message,
email,
handwritten_note,
printed_mail,
in_person,
voicemail,
other
Example:

"phone_call"

work_scope
enum<string>

Owner or next-task scope in event timezone.

Available options:
my_invitees,
overdue,
due_this_week
Example:

"my_invitees"

sort
enum<string>

Sort key; defaults name, missing task/owner values last.

Available options:
name,
next_task,
last_interaction,
stage,
owner
Example:

"name"

direction
enum<string>

Sort direction; default asc.

Available options:
asc,
desc
Example:

"asc"

Response

List event invitees completed.

data
object[]
summary
object
pagination
object