Fields

Fetch all field values defined for a single entity.

Changed on
get/v2/fields

Request

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

Query parameters

entity_idinteger required

The ID of the entity.

entity_type'booking' | 'property' | 'quote' | 'user' | 'guest' | 'owner' required

Entity types that support custom fields. This is a subset of EntityType enum values for entities that implement IFieldableEntity. Values must match the corresponding EntityType enum values to allow for translation.

The type of the entity.

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

    • 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

    • info

      api operation id Fields_Get removed and replaced with get-fields