OWownerrez
FieldDefinitions

Fetch all possible field definitions.

Changed on
get/v2/fielddefinitions

Request

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

Query parameters

type'booking' | 'property' | 'account' | 'owner' | 'contact'

The type of records to which this field applies.

Filter by the type of record a definition applies to.

activeboolean nullable

Filter by status.

limitinteger

Maximum records to return. Default 20, maximum 100.

offsetinteger

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

Response

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

  • 838877899156Revision changes
    • 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

  • 00db66c44181Revision changes
    • info

      api operation id FieldDefinitions_Get removed and replaced with get-fielddefinitions