Skip to content

Relationships

Schema relationships
graph LR
    Fields -->|"field_groups"| FieldGroups

Properties

created_atstring · date-time

The date and time of the field's creation

descriptionstring

The field's description

entity_typestring

The entity type the field belongs to

Possible values:
contactaccountopportunity
field_groupsobject[]
References: FieldGroups → id
idstring

The field group's unique identifier

namestring

The field group's name

idstring

The field's unique identifier

is_editableboolean

Whether the field is editable

is_hiddenboolean

Whether the field is hidden

is_requiredboolean

Whether the field is required

is_uniqueboolean

Whether the field is unique

is_user_definedboolean

Whether the field is user defined

labelstring

The field's label

namestring

The field's name. This is the name of the property in the entity.

optionsobject[]

The field's options

descriptionstring

The option's description

is_hiddenboolean

Whether the option is hidden

labelstring

The option's label

valuestring

The option's value

reference_entitystring

The entity type this field references to

Possible values:
contactaccountopportunitylead
remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The field's type

Possible values:
stringtextrich_textnumberbooleandatedatetimetimeenumarrayfileaddress
updated_atstring · date-time

The date and time of the field's last update

urlsobject[]

The field's urls

typestring

The field's URL type

urlstring

The field's URL