Search event guests

get

https://{tenant}.onechurchsoftware.com/api/events/{eventId}/guests

Retrieve the guests of the given event, including each guest's RSVP status, sign-up times and form entry. Custom fields are also supported as filters; see filtering by custom fields.

Required permission: Full Read Events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

eventId

int32

required

≥ 1

The id of the event.

Query Params

status

string

Comma-delimited list of RSVP status ids (or status names). Values come from /api/property_values/rsvp_status/values.

times

string

Comma-delimited list of event time ids. Use -1 to include guests not signed up for a specific time. The event's times are returned by /api/events/{id}.

person

int32

≥ 1

The id of a person. Returns only that person's guest records.

additional

boolean

When true, return only guests bringing additional people; when false, only guests with no additional spots.

string

Return guests whose email address contains the given text.

phone

string

Return guests whose phone number contains the given digits.

name

string

Text matched against the guest's names and aliases. When multiple words are given, every word must match.

comments

string

Return guests whose comments contain the given text.

spots.start

double

Return guests with at least this many additional spots.

spots.end

double

Return guests with at most this many additional spots.

unmatched

boolean

When true, return only guests not linked to a profile; when false, only guests linked to one.

campus

string

Comma-delimited list of campus ids. Matches the guest's primary campus; use -1 to include guests without one. Values come from /api/locations.

date.start

date-time

Return guests of events starting on or after this date.

date.end

date-time

Return guests of events starting on or before this date.

created.start

date-time

Return guests added on or after this date.

created.end

date-time

Return guests added on or before this date.

paid.start

double

Return guests who paid at least this amount.

paid.end

double

Return guests who paid at most this amount.

formName

string

Return guests whose sign-up form's name contains the given text.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found