Skip to main content
GET
List all guests

Authorizations

x-api-key
string
header
required

Query Parameters

event
string
required

Event ID to scope the guest list.

skip
integer

Number of records to skip for pagination.

Required range: x >= 0
Example:

0

limit
integer
default:20

Maximum number of records to return.

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

20

Search term for filtering guests by first name, last name, or email.

Example:

"john"

email
string

Filter guests by exact email address match.

Example:

"john@example.com"

sortBy
string

Sort field and direction (field:asc|desc).

Example:

"lastName:asc"

filterBy
string

JSON-encoded filter criteria for guest properties.

Example:

"{\"status.confirmation\":1}"

Response

List of guests with pagination metadata.

results
object[]
total
integer

Total count of matching guests