Deposits

Query for a pageable list of deposits.

Changed on
get/v2/deposits

Request

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

Query parameters

since_utcstring date-time nullable

Filter for deposits created or changed since a specific date (UTC).

booking_idinteger nullable

Filter for deposits that reference a booking.

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

The paged result of deposits.

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

    • info

      query request parameter offset was deprecated

    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status