Sign in
FieldDefinitions

Fetch a field definition.

get/v2/fielddefinitions/{id}

Path parameters

idinteger required

The field definition unqiue Id.

Response

A model representing the field definition.

idinteger

The ID of this record.

codestring

The field code without any prefix. E.g. "F1".

descriptionstring
full_codestring

The fully qualified field code as used in templates. E.g. "BXF1".

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

The type of records to which this field applies.

Changes

Changed in 1 of the 7 revisions of this API.1

  • 00db66c441811See the full diff
    • ○

      api operation id FieldDefinitions_Get2 removed and replaced with get-fielddefinitions-id

      api-operation-id-removed