Skip to main content
GET
List participants by their answer to a booking form field

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The event occurrence's id.

publicId
string
required

The public ID the organizer gave the booking form field, as a participant's fields report it.

Query Parameters

page[size]
number | null

How many results to return per page, from 1 to 500. Defaults to 100.

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

100

page[after]
string | null

Pass page.next from the previous response to get the next page.

page[before]
string | null

Pass page.prev from the previous response to get the previous page.

sort[updatedAt]
enum<string> | null

Sort by update date. 1 for ascending, -1 for descending.

Available options:
1,
-1,
null
Example:

"1"

sort[createdAt]
enum<string> | null

Sort by creation date. 1 for ascending, -1 for descending.

Available options:
1,
-1,
null
Example:

"1"

createdAt[after]
string<date-time> | null

Only return entries created after this date.

Example:

"2020-01-01T20:15:00.000Z"

createdAt[before]
string<date-time> | null

Only return entries created before this date.

Example:

"2020-01-01T20:15:00.000Z"

updatedAt[after]
string<date-time> | null

Only return entries updated after this date.

Example:

"2020-01-01T20:15:00.000Z"

updatedAt[before]
string<date-time> | null

Only return entries updated before this date.

Example:

"2020-01-01T20:15:00.000Z"

value
string
required

The exact recorded answer to match, including any surrounding whitespace. Use the stored value or option key, which may differ from the displayed label. Blank values are rejected.

Minimum string length: 1
Example:

"Opt-in"

Response

A page of matching participants, each with their details and the matched answer.

data
FormFieldRespondent · object[]
required
page
object
required