Leads Object

Example Lead Object (i.e. example JSON response)

{
    "anonymous": true,
    "app_id": "abc3wodw",
    "avatar": {
        "image_url": "https://secure.gravatar.com/avatar/af060c6?",
        "type": "avatar"
    },
    "companies": {
        "companies": [],
        "type": "company.list"
    },
    "created_at": 1503488750,
    "custom_attributes": {},
    "do_not_track": null,
    "email": "[email protected]",
    "has_hard_bounced": false,
    "id": "599d6aeeda883ed8ba7c2",
    "last_request_at": 1503488749,
    "location_data": {
        "city_name": "Pretoria",
        "continent_code": "AF",
        "country_code": "ZAF",
        "country_name": "South Africa",
        "postal_code": "0118",
        "region_name": "Gauteng",
        "timezone": "Africa/Johannesburg",
        "type": "location_data"
    },
    "marked_email_as_spam": false,
    "name": null,
    "owner_id": "321452",
    "phone": null,
    "pseudonym": "Test from Pretoria",
    "referrer": null,
    "remote_created_at": null,
    "segments": {
        "segments": [],
        "type": "segment.list"
    },
    "session_count": 0,
    "signed_up_at": null,
    "social_profiles": {
        "social_profiles": [
            {
                "id": "123456",
                "name": "GooglePlus",
                "type": "social_profile",
                "url": "https://plus.google.com/123456",
                "username": null
            }
        ],
        "type": "social_profile.list"
    },
    "tags": {
        "tags": [],
        "type": "tag.list"
    },
    "type": "contact",
    "unsubscribed_from_emails": false,
    "updated_at": 1520946390,
    "user_id": "e477-55c-47d5-96d3-e45bf",
    "utm_campaign": null,
    "utm_content": null,
    "utm_medium": null,
    "utm_source": null,
    "utm_term": null
}

A lead object contains the following fields -

Attribute	Type	Description
type	string	value is 'contact'
id	string	The Intercom defined id representing the Lead
created_at	timestamp	The time the Lead was added to Intercom
updated_at	timestamp	The last time the Lead was updated
user_id	string	Automatically generated identifier for the Lead
email	string	The email you have defined for the Lead
phone	string	The phone number you have defined for the lead
name	string	The name of the Lead
custom_attributes	object	The custom attributes you have set on the Lead
last_request_at	timestamp	The time the Lead last recorded making a request
avatar	object	An avatar object for the Lead
unsubscribed_from_emails	boolean	Whether the Lead is unsubscribed from emails
location_data	object	A Location Object relating to the Lead
companies	list	A list of companies for the Lead
social_profiles	list	A list of social profiles associated with the Lead
segments	list	This will return an empty list of segments as part of our effort to deprecate this attribute on the lead model for performance and accuracy reasons.
tags	list	A list of tags associated with the Lead.
referrer	string	The URL of the page the lead was last on
utm_source	string	Identifies which site sent the traffic
utm_medium	string	Identifies what type of link was used
utm_campaign	string	Identifies a specific product promotion or strategic campaign
utm_term	string	Identifies search terms
utm_content	string	Identifies what specifically was clicked to bring the user to the site

📘
Information on social profile, avatar and location objects can be found under the Users documentation.