Filter

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.

Languages
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

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

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

Filter

A filter that can be applied to variables in campaigns or lists

Filter

A filter that can be applied to variables in campaigns or lists

resource_idstring(uuid)required

ID of the resource (campaign or list) this filter applies to

Example: "01991f17-c9b8-7d5a-9c1e-7c8ddc9bdfaa"
typenumberrequired

Type of filter to apply

Enum ValueDescription
1

Equal to

2

Not equal to

3

Contains

4

Does not contain

5

Contains any of

6

Does not contain any of

7

Is empty

8

Is not empty

Example: 1
column_namestringrequired

Name of the column/variable to filter on

Example: "company_size"
organization_idstring(uuid)read-onlyrequired

ID of the organization this filter belongs to

Example: "01991f17-c9b8-7d5a-9c1e-7c8e038b53ec"
idnull or string(uuid)read-only

Unique identifier for the filter

Example: "01991f17-c9b8-7d5a-9c1e-7c8c075fac23"
valueArray of strings

Value to filter on

Example: ["100000"]
timestamp_creatednull or string(date-time)read-only

Timestamp when the filter was created

Example: "2024-01-01T00:00:00.000Z"
timestamp_updatednull or string(date-time)read-only

Timestamp when the filter was last updated

Example: "2024-01-01T00:00:00.000Z"
{
  "id": "01991f17-c9b8-7d5a-9c1e-7c8c075fac23",
  "resource_id": "01991f17-c9b8-7d5a-9c1e-7c8ddc9bdfaa",
  "type": 1,
  "column_name": "company_size",
  "organization_id": "01991f17-c9b8-7d5a-9c1e-7c8e038b53ec",
  "value": [
    "100000"
  ],
  "timestamp_created": "2024-01-01T00:00:00.000Z",
  "timestamp_updated": "2024-01-01T00:00:00.000Z"
}

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Schemas