Link Search Menu Expand Document
Wherewolf

Get Guests By Filter endpoint

Returns a list of guests (aka waivers) filtered by the provided parameters.

Parameters:

  • filter object, the filter to apply to the guests.
  • filter.dateRange object, the date range to apply to the guests.
  • filter.dateRange.dateAfter string, the start of the desired time window in UTC ISO 8601.
  • filter.dateRange.dateBefore string, the end of the desired time window in UTC ISO 8601.
  • limit number, the maximum number of results to return.
  • selection string, is either cropped or full. The difference being that cropped placeholders any large fields like signatures, photos, and the Terms and Conditions that were signed, while full returns them in their entirety.
  • pool string to identify the Wherewolf app making the request.
  • key string to authenticate the request.

Request example

curl 'https://api.wherewolf.co.nz/guest/getByFilter' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filter":{"dateRange":{"dateAfter":"2025-12-16T08:00:00.000Z","dateBefore":"2025-12-17T07:59:59.999Z"}},"limit":10000,"selection":"cropped","key":"__API_KEY__","pool":"__APP_POOL_ID__"}'

Where API_KEY is a placeholder for your API key and APP_POOL_ID is a placeholder for your app pool id.

The response is an array of guests (aka waivers) filtered by the provided parameters. Each guest object contains many properties that may be filled depending on the use case.

Some commonly found properties are:

  • id unique identifier of the waiver.
  • email email of the guest.
  • pool pool of the waiver.