Custom Fields

Supported custom field attributes:

Attribute Type Description
id number Unique identifier of the custom field.
name string Name of the custom field.
type string Type of the custom field.
resource_type string Type name of the resource the custom field can be attached to.
Possible values: lead, contact, prospect_and_customer, deal

Custom field type

Every custom field has defined type, which implies possible value format:

Type Value Format
address Address
bool boolean
(true)
date string
(4/27/2016)
datetime string
(4/28/2016 6:00)
email string
(abc@acme.com)
list object
({id:1, name:ABC})
multi_select_list array
([{id:1, name:ABC},{id:3, name:XYZ}])
number string
(123.45)
phone string
string string
text string
url string
(http://foobar.com)

Endpoints

Stream Custom Fields

Read the stream of custom fields events.

See Overview article for more details on request and response formats and parameters.