OWownerrez
Guests

Query for a pageable list of guests.

Changed on

At least one of q, created_since_utc, from, or to is required.

get/v2/guests

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/guests
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

qstring nullable

Filter by search query.

created_since_utcstring date-time nullable

Filter by created date (UTC).

fromstring date nullable

Filter for guests that depart on or after the supplied calendar date (in property timezone). Time and UTC offset components are ignored: 2026-03-01T00:00:00-05:00 filters from March 1, just like 2026-03-01.

tostring date nullable

Filter for guests that arrive on or before the supplied calendar date (in property timezone). Time and UTC offset components are ignored.

include_tagsboolean

Include tags collection on results.

include_fieldsboolean

Include fields collection on results.

limitinteger

Maximum records to return. Default 20, maximum 100.

offsetinteger

Deprecated: rejected above 0 from 2027-01-05. Follow next_page_url instead. Records to skip from the start of the collection. Default 0.

cursorstring

Opaque cursor from a previous response's next_page_url. Prefer following that link over computing offsets: a cursor pages by record id, so rows inserted while you page are not skipped or repeated. A cursor issued under different filters is ignored and paging falls back to offset.

Response

A pageable list of GuestModels representing the matching Guests.

limitinteger

The maximum number of records per page.

next_page_urlstring

URL to fetch the next page of records. A null value indicates that there are no more pages in the collection.

offsetinteger

The current offset from the start of the collection.

Changes

  • 35db8ad62f61Revision changes
    • breaking

      for the query request parameter from, the format changed from date-time to date

    • breaking

      for the query request parameter to, the format changed from date-time to date

  • c78b5def2f80Revision changes
    • info

      query request parameter offset was deprecated