For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Lead object
          • GET/leads
          • POST/leads
          • GET/leads/{id}
          • GET/leads/meta/post
          • GET/leads/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsLeads

The Lead object

The Lead Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "owner": "string",
7  "lead_source": "string",
8  "title": "string",
9  "company": "string",
10  "first_name": "string",
11  "last_name": "string",
12  "addresses": [
13    {
14      "created_at": "2023-01-01T00:00:00Z",
15      "modified_at": "2023-01-01T00:00:00Z",
16      "street_1": "string",
17      "street_2": "string",
18      "city": "string",
19      "state": "string",
20      "postal_code": "string",
21      "country": "AF",
22      "address_type": "BILLING"
23    }
24  ],
25  "email_addresses": [
26    {
27      "created_at": "2023-01-01T00:00:00Z",
28      "modified_at": "2023-01-01T00:00:00Z",
29      "email_address": "string",
30      "email_address_type": "string"
31    }
32  ],
33  "phone_numbers": [
34    {
35      "created_at": "2023-01-01T00:00:00Z",
36      "modified_at": "2023-01-01T00:00:00Z",
37      "phone_number": "string",
38      "phone_number_type": "string"
39    }
40  ],
41  "remote_updated_at": "2023-01-01T00:00:00Z",
42  "remote_created_at": "2023-01-01T00:00:00Z",
43  "converted_date": "2023-01-01T00:00:00Z",
44  "converted_contact": "string",
45  "converted_account": "string",
46  "status": "OPEN",
47  "remote_was_deleted": true,
48  "field_mappings": {},
49  "remote_data": [
50    {
51      "path": "string",
52      "data": {}
53    }
54  ],
55  "remote_fields": [
56    {
57      "remote_field_class": {
58        "id": "string",
59        "display_name": "string",
60        "remote_key_name": "string",
61        "description": "string",
62        "is_custom": true,
63        "is_common_model_field": true,
64        "is_required": true,
65        "field_type": "string",
66        "field_format": "string",
67        "field_choices": [
68          "string"
69        ],
70        "item_schema": {
71          "item_type": "string",
72          "item_format": "string",
73          "item_choices": [
74            "string"
75          ]
76        }
77      },
78      "value": {
79        "string": {}
80      }
81    }
82  ]
83}
Was this page helpful?
Previous

/engagements/remote-field-classes

Next

/leads

Built with

The Lead object is used to represent an individual who is a potential customer.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
ownerstring or nullOptionalformat: "uuid"
The lead's owner.
lead_sourcestring or nullOptional
The lead's source.
titlestring or nullOptional
The lead's title.
companystring or nullOptional
The lead's company.
first_namestring or nullOptional
The lead's first name.
last_namestring or nullOptional
The lead's last name.
addresseslist of objectsOptionalRead-only
email_addresseslist of objectsOptionalRead-only
phone_numberslist of objectsOptionalRead-only
remote_updated_atdatetime or nullOptional
When the third party's lead was updated.
remote_created_atdatetime or nullOptional
When the third party's lead was created.
converted_datedatetime or nullOptional
When the lead was converted.
converted_contactstring or nullOptionalformat: "uuid"
The contact of the converted lead.
converted_accountstring or nullOptionalformat: "uuid"
The account of the converted lead.
statusenum or nullOptional

The lead's status.

  • OPEN - OPEN
  • CLOSED - CLOSED
  • UNQUALIFIED - UNQUALIFIED
  • QUALIFIED - QUALIFIED
Allowed values:
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only