This schema describes objects returned by the Lead endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the lead (read-only) |
timestamp_created | string (date-time) | Yes | Timestamp when the lead was created (read-only) |
timestamp_updated | string (date-time) | Yes | Timestamp when the lead was last updated (read-only) |
organization | string (uuid) | Yes | Organization ID associated with the lead (read-only) |
campaign | string (uuid), nullable | No | Campaign ID associated with the lead |
status | number | Yes | Status of the lead. Possible values: 1 (Active), 2 (Paused), 3 (Completed), -1 (Bounced), -2 (Unsubscribed), -3 (Skipped) (read-only) |
email | string, nullable | No | Email address of the lead |
personalization | string, nullable | No | Personalization of the lead |
website | string, nullable | No | Website of the lead |
last_name | string, nullable | No | Last name of the lead |
first_name | string, nullable | No | First name of the lead |
company_name | string, nullable | No | Company name of the lead |
phone | string, nullable | No | Phone number of the lead |
email_open_count | number | Yes | Number of times the email was opened (read-only) |
email_reply_count | number | Yes | Number of times the email was replied to (read-only) |
email_click_count | number | Yes | Number of times the email was clicked (read-only) |
company_domain | string | Yes | Company domain of the lead (read-only) |
status_summary | object | Yes | Status summary of the lead (read-only) |
status_summary.lastStep | object | No | |
status_summary.lastStep.from | string | No | |
status_summary.lastStep.stepID | string | No | |
status_summary.lastStep.timestamp_executed | string (date-time) | No | |
status_summary.domain_complete | boolean | No | |
payload | object, nullable | No | Lead custom variables. This object can contain any key, but the values have to be of type string, number, boolean, or null. We do NOT allow objects or arrays as values. (read-only) |
payload.firstName | string | No | |
payload.lastName | string | No | |
payload.companyName | string | No | |
payload.website | string | No | |
payload.phone | string | No | |
payload.personalization | string | No | |
status_summary_subseq | object | No | Subsequence status summary of the lead (read-only) |
status_summary_subseq.from | string | No | |
status_summary_subseq.stepID | string | No | |
status_summary_subseq.timestampExecuted | string (date-time) | No | |
last_step_from | string, nullable | No | Source of the last step (read-only) |
last_step_id | string (uuid), nullable | No | ID of the last step (read-only) |
last_step_timestamp_executed | string (date-time), nullable | No | Timestamp when the last step was executed (read-only) |
email_opened_step | number, nullable | No | Last email step opened by the lead (read-only) |
email_opened_variant | number, nullable | No | Last step variant opened by the lead (read-only) |
email_replied_step | number, nullable | No | Last email step the lead has replied to (read-only) |
email_replied_variant | number, nullable | No | Last step variant the lead has replied to (read-only) |
email_clicked_step | number, nullable | No | Last email step the lead has clicked (read-only) |
email_clicked_variant | number, nullable | No | Last step variant the lead has clicked (read-only) |
lt_interest_status | number | No | Lead interest status. It can be either a static value (check below), or a custom status interest value. Possible values: 1 (Interested), 2 (Meeting Booked), 3 (Meeting Completed), 4 (Won), 0 (Out of Office), -1 (Not Interested), -2 (Wrong Person), -3 (Lost), -4 (No Show) |
subsequence_id | string, nullable | No | ID of the subsequence (read-only) |
verification_status | number | No | Verification status of the lead. Possible values: 1 (Verified), -1 (Invalid), -2 (Risky), -3 (Catch All), -4 (Job Change), 11 (Pending), 12 (Pending Verification Job) (read-only) |
pl_value_lead | string, nullable | No | Potential value of the lead |
timestamp_added_subsequence | string (date-time), nullable | No | Timestamp when the lead was added to the subsequence (read-only) |
timestamp_last_contact | string (date-time), nullable | No | Timestamp of the last contact with the lead (read-only) |
timestamp_last_open | string (date-time), nullable | No | Timestamp of the last email open (read-only) |
timestamp_last_reply | string (date-time), nullable | No | Timestamp of the last email reply (read-only) |
timestamp_last_interest_change | string (date-time), nullable | No | Timestamp of the last interest status change (read-only) |
timestamp_last_click | string (date-time), nullable | No | Timestamp of the last email click (read-only) |
enrichment_status | number | No | Enrichment status of the lead. Possible values: 1 (Enriched), -1 (Enrichment data not available), 11 (Pending), -2 (Error) (read-only) |
list_id | string (uuid), nullable | No | List ID associated with the lead |
last_contacted_from | string, nullable | No | Source of the last contact (read-only) |
uploaded_by_user | string (uuid), nullable | No | ID of the user who uploaded the lead (read-only) |
upload_method | string | No | Method used to upload the lead. Possible values: manual (Manual), api (API), website-visitor (Website Visitor) (read-only) |
assigned_to | string (uuid), nullable | No | ID of the user assigned to the lead |
is_website_visitor | boolean, nullable | No | Indicates if the lead is a website visitor (read-only) |
timestamp_last_touch | string (date-time), nullable | No | Timestamp of the last touch with the lead (read-only) |
esp_code | number | No | ESP code associated with the lead. Possible values: 0 (In Queue), 1 (Google), 2 (Microsoft), 3 (Zoho), 8 (AirMail), 9 (Yahoo), 10 (Yandex), 12 (Web.de), 13 (Libero.it), 999 (Other), 1000 (Not Found) (read-only) |
esg_code | number | No | ESG code associated with the lead. Possible values: 0 (In Queue), 1 (Barracuda), 2 (Mimecast), 3 (Proofpoint), 4 (Cisco) (read-only) |