Workspace

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

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

Operations

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

A SuperSearch enrichment that retrieves and enriches leads based on search filters

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

Clause

A clause (filter or sort) that can be applied to variables in campaigns or lists

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Schemas

Lead Label

A custom label for categorizing and managing leads

idstring(uuid)read-onlyrequired

Unique identifier for the custom lead label

Example: "019942fb-54ca-7c08-ad7c-3520c58e97df"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the custom lead label was created

Example: "2025-09-13T12:09:51.562Z"

created_bystring(uuid)read-onlyrequired

User ID of the creator of this label

Example: "019942fb-54ca-7c08-ad7c-352192a91619"

organization_idstring(uuid)read-onlyrequired

Organization ID that owns this custom lead label

Example: "019942fb-54ca-7c08-ad7c-352216ea128a"

labelstringrequired

Display label for the custom lead label

Example: "Hot Lead"

interest_status_labelstringrequired

Interest status label associated with this label

Enum Value	Description
positive	Positive
negative	Negative
neutral	Neutral

Example: "positive"

interest_statusnumberread-onlyrequired

Interest status associated with this label. This is generated automatically by us.

Example: 1

descriptionnull or string

Detailed description of the custom lead label purpose

Example: "Used for marking high-priority leads"

use_with_ainull or boolean

Whether this label should be used with AI features

Example: false

{
  "id": "019942fb-54ca-7c08-ad7c-3520c58e97df",
  "timestamp_created": "2025-09-13T12:09:51.562Z",
  "created_by": "019942fb-54ca-7c08-ad7c-352192a91619",
  "organization_id": "019942fb-54ca-7c08-ad7c-352216ea128a",
  "label": "Hot Lead",
  "interest_status_label": "positive",
  "interest_status": 1,
  "description": "Used for marking high-priority leads",
  "use_with_ai": false
}

Workspace

A workspace entity representing a workspace

idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "019942fb-54ce-7271-9b74-3e586cb4960a"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-09-13T12:09:51.566Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-09-13T12:09:51.566Z"

ownerstring(uuid)required

User ID of the workspace owner

Example: "019942fb-54ce-7271-9b74-3e59bbe41530"

namestringrequired

Name of the workspace

Example: "My Workspace"

plan_idnull or stringread-only

Plan ID for workspace

Example: "pid_hg_v1"

add_unsub_to_blocknull or boolean

Whether to add unsubscribes to block list

Example: false

default_opportunity_valuenull or number

Default value for opportunities

Example: 250

plan_id_leadfindernull or stringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"

plan_id_verificationobjectread-only

Plan ID for verification service

org_logo_urlnull or stringread-only

URL to workspace logo

Example: "https://example.com/logo.png"

org_client_domainnull or stringread-only

The domain for the white label agency mode

Example: "example.com"

plan_id_crmnull or stringread-only

Plan ID for CRM

Example: "pid_crm_v1"

plan_id_website_visitornull or stringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"

plan_id_inbox_placementnull or stringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"

{
  "id": "019942fb-54ce-7271-9b74-3e586cb4960a",
  "timestamp_created": "2025-09-13T12:09:51.566Z",
  "timestamp_updated": "2025-09-13T12:09:51.566Z",
  "owner": "019942fb-54ce-7271-9b74-3e59bbe41530",
  "name": "My Workspace",
  "plan_id": "pid_hg_v1",
  "add_unsub_to_block": false,
  "default_opportunity_value": 250,
  "plan_id_leadfinder": "pid_lf_ls_v1",
  "plan_id_verification": {
    "quantity": 5,
    "product_id": "pid_verify_v1_monthly",
    "timestamp_updated": "2024-07-22T05:56:58.667Z"
  },
  "org_logo_url": "https://example.com/logo.png",
  "org_client_domain": "example.com",
  "plan_id_crm": "pid_crm_v1",
  "plan_id_website_visitor": "pid_wvw_v1",
  "plan_id_inbox_placement": "pid_ip_v1"
}

SuperSearch Enrichment

A SuperSearch enrichment that retrieves and enriches leads based on search filters

idstring(uuid)read-onlyrequired

Unique identifier for the enrichment

Example: "019942fb-54d2-7d4f-8a4c-5aee2d3ff6f9"

organization_idstring(uuid)read-onlyrequired

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

resource_idstring(uuid)read-onlyrequired

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumberread-onlyrequired

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

{
  "id": "019942fb-54d2-7d4f-8a4c-5aee2d3ff6f9",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}