Skip to main content
GET
List an Event's bookings

Headers

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

Path Parameters

uuid
string<uuid>
required

Event UUID. Accepts the canonical UUID (e.g. 018ff5cd-6dc4-7d57-bcbc-374702ca8b38) or its short-uuid (Flickr Base58) form (e.g. 1cbZYoAFoJdwqN4tixezd5).

Query Parameters

cursor
string

Opaque cursor for cursor-based pagination. Pass the pagination.nextCursor value from a previous response to fetch the next page. Omit to fetch the first page.

limit
number
default:50

Maximum number of guests to return.

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

25

rsvpResponse
enum<string>

Filter by the guest's RSVP response.

Available options:
YES,
NO,
MAYBE

Filter by guest name or email, case-insensitive substring match.

Maximum string length: 255
locationId
string

Filter by the location the guest registered for.

Maximum string length: 128

Response

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object[]
required
pagination
object
required