Appearance

Fields Object ​


id
string

The field's unique identifier

name
string

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

label
string

The field's label

description
string

The field's description

type
string

The field's type

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • address
is_hidden
boolean

Whether the field is hidden

is_unique
boolean

Whether the field is unique

is_required
boolean

Whether the field is required

is_editable
boolean

Whether the field is editable

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

is_user_defined
boolean

Whether the field is user defined

entity_type
string

The entity type the field belongs to

All possible enum values:
  • contact
  • account
  • opportunity
field_groups
object[]
id
string

The field group's unique identifier

name
string

The field group's name

created_at
string · date-time

The date and time of the field's creation

updated_at
string · date-time

The date and time of the field's last update

remote_data
object

Raw data returned from the remote API call.