Skip to content

Leads Object

Relationships

Schema relationships 
graph LR
    Leads -->|"contact"| Contacts
    Leads -->|"account"| Accounts

Properties

idstring
required·

The lead' unique identifier

accountobject

The lead's account

References: Accounts → id
idstring

The account's unique identifier

addressesobject[]
citystring

The city

countrystring

The country

postal_codestring

The postal code

statestring

The state

street_1string

Line 1 of the street address

street_2string

Line 2 of the street address

typestring

The address type

contactobject

The contact associated with the lead

References: Contacts → id
idstring

The contact's unique identifier

converted_accountstring

The lead's converted account

converted_atstring · date-time

The date and time of the lead's conversion

converted_contactstring

The lead's converted contact

created_atstring · date-time

The date and time of the lead's creation

custom_fieldsRecord<string, any>

All the custom fields present on the lead

email_addressesobject[]
emailstring

The email address

typestring

The email address type

first_namestring

The lead's first name

last_activity_atstring · date-time

The date and time of the lead's last activity

last_namestring

The lead's last name

lead_sourcestring

The lead's source

lead_typestring

The lead's type

ownerobject

The lead's owner

idstring

The lead's owner's unique identifier

phone_numbersobject[]
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The phone number type

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The lead's status

titlestring

The lead's title

updated_atstring · date-time

The date and time of the lead's last update

urlsobject[]

The lead's urls

typestring

The lead's URL type

urlstring

The lead's URL