Sign in
Guests

Fetch guests

get/guests

Query parameters

idsstring

Filter by object IDs

querystring

Filter by a freetext string. Properties searched: name

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

Response

OK

idinteger required

The ID of the guest

resource_type'Guest' required

The resource type of the guest

namestring required

The name of the guest

emailstring email nullable required

The email of the guest.

phone_numberstring nullable required

The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.

created_atstring date-time required

When the guest was created

updated_atstring date-time required

When the guest was updated

Changes