OWownerrez
Agreements

Fetch the account's rental agreements, without their bodies.

Changed on
get/v2/agreements

Request

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

Query parameters

activeboolean nullable

Filter by active status. Default is null (active and inactive).

limitinteger

Maximum records to return. Default 20, maximum 100.

offsetinteger

Records to skip from the start of the collection. Default 0.

Response

A list of agreement models.

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.

countinteger

The total number of records in the collection.

Changes