Skip to main content
POST
Browse guests
The fields a criterion can target, and the operators each one accepts, are listed on the Search criteria page.

Authorizations

Authorization
string
header
required

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

Path Parameters

entity_id
string<uuid>
required

Body

application/json
limit
integer

Number of items to return in one page.

afterKey
string

Cursor of the next page, taken from the afterKey of the previous response. Leave it out on the first call.

query
object

Response

List of guests

guests
object[]
afterKey
string

Cursor of the next page. Send it back in the next request to continue; it is absent on the last page.