Custom Fields

The Custom Fields API provides a simple interface to manage your custom fields per resource type.

Custom field type

Each custom field has a defined type, which has a corresponding 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)

Properties

Attribute Description
id number readonly

Unique identifier of the custom field.

name string

Name of the custom field.

type string
choices array

Represents choices that can be used for this particular custom field (applicable only for multi_select_list and list).

for_company bool

Whether custom field should be available on Contact: Company (applicable only for resource_type=contact).

for_contact bool

Whether custom field should be available on Contact: Person (applicable only for resource_type=contact).

updated_at string readonly

UTC date and time that the record was last updated, in ISO8601 format.

created_at string readonly

UTC date and time that the record was created, in ISO8601 format.


Endpoints


Retrieve all custom fields

Returns all custom fields associated with the specified resource type.

Parameters

Attribute Description
resource_type string required

Specifies the type for which custom fields should be returned.

Possible values:

  • lead
  • contact
  • deal
  • prospect_and_customer