/

Get verification statistics for a lead list

API Explorer (2.0.0)

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.

Servers

Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Lead List

A list used to store leads

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

namestringrequired

Name of the lead list

Example: "My Lead List"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

{
  "id": "0199d953-116e-7f6e-9b53-b1ebde86d892",
  "organization_id": "0199d953-116e-7f6e-9b53-b1ec91dd9ff5",
  "has_enrichment_task": false,
  "owned_by": "0199d953-116e-7f6e-9b53-b1ed1121b00e",
  "name": "My Lead List",
  "timestamp_created": "2025-10-12T16:48:43.886Z"
}

Create lead list

Request

Requires one of the following scopes: lead_lists:create, lead_lists:all, all:create, all:all

Bodyapplication/jsonrequired

The Lead List to create

namestringrequired

Name of the lead list

Example: "My Lead List"

has_enrichment_taskboolean or null

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bystring or null(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

curl -i -X POST \
  https://api.instantly.ai/api/v2/lead-lists \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Lead List"
  }'

Responses

The Lead List

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

namestringrequired

Name of the lead list

Example: "My Lead List"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

Response

application/json

{
  "id": "0199d953-116e-7f6e-9b53-b1ebde86d892",
  "organization_id": "0199d953-116e-7f6e-9b53-b1ec91dd9ff5",
  "has_enrichment_task": false,
  "owned_by": "0199d953-116e-7f6e-9b53-b1ed1121b00e",
  "name": "My Lead List",
  "timestamp_created": "2025-10-12T16:48:43.886Z"
}

List lead list

Request

Requires one of the following scopes: lead_lists:read, lead_lists:all, all:read, all:all

Query

limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10

starting_afterstring

The starting after timestamp to filter lead lists by.

Example: starting_after=2025-03-07T00:00:00.000Z

has_enrichment_taskboolean

Whether the list has an enrichment task.

Example: has_enrichment_task=true

searchstring

The search query to filter lead lists by.

Example: search=Summer 2025 List

curl -i -X GET \
  'https://api.instantly.ai/api/v2/lead-lists?has_enrichment_task=true&limit=10&search=Summer%202025%20List&starting_after=2025-03-07T00%3A00%3A00.000Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Lead List

Bodyapplication/json

itemsArray of objects(Lead List)required

The list of Lead List

items[].idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

items[].organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

items[].namestringrequired

Name of the lead list

Example: "My Lead List"

items[].timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

items[].has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

items[].owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example: "0199d953-309d-72a2-b5b8-e343a0865d6b"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "0199d953-309d-72a2-b5b8-e343a0865d6b"
}

Get lead list

Request

Requires one of the following scopes: lead_lists:read, lead_lists:all, all:read, all:all

Path

idstring(uuid)required

The ID of the requested item

Example: 0199d953-309e-7a4a-9fbc-a269ef925dbc

curl -i -X GET \
  https://api.instantly.ai/api/v2/lead-lists/0199d953-309e-7a4a-9fbc-a269ef925dbc \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Lead List

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

namestringrequired

Name of the lead list

Example: "My Lead List"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

Response

application/json

{
  "id": "0199d953-116e-7f6e-9b53-b1ebde86d892",
  "organization_id": "0199d953-116e-7f6e-9b53-b1ec91dd9ff5",
  "has_enrichment_task": false,
  "owned_by": "0199d953-116e-7f6e-9b53-b1ed1121b00e",
  "name": "My Lead List",
  "timestamp_created": "2025-10-12T16:48:43.886Z"
}

Patch lead list

Request

Requires one of the following scopes: lead_lists:update, lead_lists:all, all:update, all:all

Path

idstring(uuid)required

The ID of the item to update

Example: 0199d953-309f-76d0-8fad-0238f961e0b9

Bodyapplication/json

non-empty

has_enrichment_taskboolean or null

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bystring or null(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

namestring

Name of the lead list

Example: "My Lead List"

curl -i -X PATCH \
  https://api.instantly.ai/api/v2/lead-lists/0199d953-309f-76d0-8fad-0238f961e0b9 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Lead List

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

namestringrequired

Name of the lead list

Example: "My Lead List"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

Response

application/json

{
  "id": "0199d953-116e-7f6e-9b53-b1ebde86d892",
  "organization_id": "0199d953-116e-7f6e-9b53-b1ec91dd9ff5",
  "has_enrichment_task": false,
  "owned_by": "0199d953-116e-7f6e-9b53-b1ed1121b00e",
  "name": "My Lead List",
  "timestamp_created": "2025-10-12T16:48:43.886Z"
}

Delete lead list

Request

Requires one of the following scopes: lead_lists:delete, lead_lists:all, all:delete, all:all

Path

idstring(uuid)required

The ID of the item to delete

Example: 0199d953-30a0-7abf-a40f-f464f8176582

Bodyapplication/json

null

curl -i -X DELETE \
  https://api.instantly.ai/api/v2/lead-lists/0199d953-30a0-7abf-a40f-f464f8176582 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

The deleted Lead List

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the lead list

Example: "0199d953-116e-7f6e-9b53-b1ebde86d892"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this lead list

Example: "0199d953-116e-7f6e-9b53-b1ec91dd9ff5"

namestringrequired

Name of the lead list

Example: "My Lead List"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the lead list was created

Example: "2025-10-12T16:48:43.886Z"

has_enrichment_tasknull or boolean

Whether this list runs the enrichment process on every added lead or not

Example: false

owned_bynull or string(uuid)

User ID of the owner of this lead list. Defaults to the user that created the list

Example: "0199d953-116e-7f6e-9b53-b1ed1121b00e"

Response

application/json

{
  "id": "0199d953-116e-7f6e-9b53-b1ebde86d892",
  "organization_id": "0199d953-116e-7f6e-9b53-b1ec91dd9ff5",
  "has_enrichment_task": false,
  "owned_by": "0199d953-116e-7f6e-9b53-b1ed1121b00e",
  "name": "My Lead List",
  "timestamp_created": "2025-10-12T16:48:43.886Z"
}

Get verification statistics for a lead list

Request

Get verification statistics for a lead list

Path

idstring(uuid)required

Example: 0199d953-30a0-7abf-a40f-f465e6f275d7

curl -i -X GET \
  https://api.instantly.ai/api/v2/lead-lists/0199d953-30a0-7abf-a40f-f465e6f275d7/verification-stats \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json

statsobjectrequired

Sums up the leads by their verification status

Example: {"verified":150,"invalid":25,"risky":10,"catch_all":5,"job_change":2,"verification_job_pending_leadfinder":11,"verification_job_pending_user":12}

stats.verifiednumber

Count of verified leads

Example: 150

stats.invalidnumber

Count of invalid leads

Example: 25

stats.riskynumber

Count of risky leads

Example: 10

stats.catch_allnumber

Count of catch all leads

Example: 5

stats.job_changenumber

Count of job change leads

Example: 2

stats.verification_job_pending_leadfindernumber

Count of verification job pending leads for leadfinder

Example: 11

stats.verification_job_pending_usernumber

Count of verification job pending leads for user

Example: 12

total_leadsnumberrequired

Total number of leads in the list

Example: 203

Response

application/json

{
  "stats": {
    "verified": 150,
    "invalid": 25,
    "risky": 10,
    "catch_all": 5,
    "job_change": 2,
    "verification_job_pending_leadfinder": 11,
    "verification_job_pending_user": 12
  },
  "total_leads": 203
}

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Webhook Event

A webhook event that was sent or attempted to be sent

Operations

DFY Email Account Order

A Done-For-You email account order

Operations

Schemas