Sign in

v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB
Fields

Fetch all field values defined for a single entity.

get/v2/fields

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.

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.