Sign in

v4

latestOpenAPI 3.0.02026-08-0879137151.8 KB
FieldDefinitions

Fetch all possible field definitions.

get/v2/fielddefinitions

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.

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.