The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.
A lead entity representing an individual lead
Unique identifier for the lead
Timestamp when the lead was created
Timestamp when the lead was last updated
Organization ID associated with the lead
Status of the lead
| Enum Value | Description |
|---|---|
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
| -1 | Bounced |
| -2 | Unsubscribed |
| -3 | Skipped |
Status summary of the lead
Campaign ID associated with the lead
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.
ID of the last step
Timestamp when the last step was executed
Lead interest status. It can be either a static value (check below), or a custom status interest value
| Enum Value | Description |
|---|---|
| 0 | Out of Office |
| 1 | Interested |
| 2 | Meeting Booked |
| 3 | Meeting Completed |
| 4 | Closed |
| -1 | Not Interested |
| -2 | Wrong Person |
| -3 | Lost |
Verification status of the lead
| Enum Value | Description |
|---|---|
| 1 | Verified |
| 11 | Pending |
| 12 | Pending Verification Job |
| -1 | Invalid |
| -2 | Risky |
| -3 | Catch All |
| -4 | Job Change |
Timestamp when the lead was added to the subsequence
Timestamp of the last contact with the lead
Timestamp of the last email open
Timestamp of the last email reply
Timestamp of the last interest status change
Timestamp of the last email click
Enrichment status of the lead
| Enum Value | Description |
|---|---|
| 1 | Enriched |
| 11 | Pending |
| -1 | Enrichment data not available |
| -2 | Error |
ID of the user who uploaded the lead
Method used to upload the lead
| Enum Value | Description |
|---|---|
| manual | Manual |
| api | API |
| website-visitor | Website Visitor |
ID of the user assigned to the lead
Timestamp of the last touch with the lead
{ "id": "01959271-1ec7-785e-b53b-fc11bab8020a", "timestamp_created": "2025-03-14T02:17:21.863Z", "timestamp_updated": "2025-03-14T02:17:21.863Z", "organization": "01959271-1ec7-785e-b53b-fc12bf16457d", "campaign": "01959271-1ec7-785e-b53b-fc130c32a4df", "status": 1, "email": "example@example.com", "personalization": "Hello, how are you?", "website": "https://example.com", "last_name": "Doe", "first_name": "John", "company_name": "Example Inc.", "phone": "+1234567890", "email_open_count": 0, "email_reply_count": 0, "email_click_count": 0, "company_domain": "example.com", "status_summary": { "from": "campaign", "stepID": "01959271-1ec7-785e-b53b-fc145a7832fc", "timestamp_executed": "2025-03-14T02:17:21.863Z" }, "payload": { "firstName": "John", "lastName": "Doe", "companyName": "Acme Corp", "website": "https://example.com", "phone": "+1234567890", "personalization": "Hi {{first_name}}, I noticed you work at {{company_name}}...", "property1": null, "property2": null }, "status_summary_subseq": { "from": "campaign", "stepID": "01959271-1ec7-785e-b53b-fc155b739b37", "timestampExecuted": "2025-03-14T02:17:21.863Z" }, "last_step_from": "campaign", "last_step_id": "01959271-1ec7-785e-b53b-fc1673bbf6f1", "last_step_timestamp_executed": "2025-03-14T02:17:21.864Z", "email_opened_step": 1, "email_opened_variant": 1, "email_replied_step": 1, "email_replied_variant": 1, "email_clicked_step": 1, "email_clicked_variant": 1, "lt_interest_status": 1, "subsequence_id": "01959271-1ec8-7187-b2ca-56cf457d9c5b", "verification_status": 1, "pl_value_lead": "High", "timestamp_added_subsequence": "2025-03-14T02:17:21.864Z", "timestamp_last_contact": "2025-03-14T02:17:21.864Z", "timestamp_last_open": "2025-03-14T02:17:21.864Z", "timestamp_last_reply": "2025-03-14T02:17:21.864Z", "timestamp_last_interest_change": "2025-03-14T02:17:21.864Z", "timestamp_last_click": "2025-03-14T02:17:21.864Z", "enrichment_status": 1, "list_id": "01959271-1ec8-7187-b2ca-56d02a0054fb", "last_contacted_from": "email", "uploaded_by_user": "01959271-1ec8-7187-b2ca-56d1f282bfd7", "upload_method": "manual", "assigned_to": "01959271-1ec8-7187-b2ca-56d2eac4fe52", "is_website_visitor": true, "timestamp_last_touch": "2025-03-14T02:17:21.864Z", "esp_code": 1 }
A background job that can be used to perform long-running tasks
Unique identifier for the background job
Workspace ID
Type of background job
| Enum Value | Description |
|---|---|
| move-leads | Move Leads |
| import-leads | Import Leads |
Job status
| Enum Value | Description |
|---|---|
| pending | The background job is waiting in the queue to be processed |
| in-progress | The background job is being processed |
| success | The background job has been successfully processed |
| failed | The background job has failed |
The id of the user that triggered the action that created the job
The id of the entity that the job is related to
Type of entity
| Enum Value | Description |
|---|---|
| list | The entity is a lead list |
| campaign | The entity is a campaign |
{ "id": "675266e304a8e55b17f0228b", "workspace_id": "01959271-1f77-7821-ad9f-a5e57e71f336", "user_id": "01959271-1f77-7821-ad9f-a5e61c680f12", "type": "move-leads", "entity_id": "01959271-1f77-7821-ad9f-a5e7bf808269", "entity_type": "list", "data": {}, "progress": 0, "status": "pending", "created_at": "2025-03-14T02:17:22.039Z", "updated_at": "2025-03-14T02:17:22.039Z" }
A custom tag for organizing and categorizing items
Unique identifier for the custom tag
Timestamp when the custom tag was created
Timestamp when the custom tag was last updated
Organization ID that owns this custom tag
{ "id": "01959271-1f78-7928-9405-c525e3898835", "timestamp_created": "2025-03-14T02:17:22.040Z", "timestamp_updated": "2025-03-14T02:17:22.040Z", "organization_id": "01959271-1f78-7928-9405-c526f300d9f9", "label": "Important", "description": "Used for marking important items" }