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 items

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

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 Group Member

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

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1bc2-7df0-a1e1-479be7a20234"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1bc2-7df0-a1e1-479c65fe6171"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

{
  "id": "01959271-1bc2-7df0-a1e1-479be7a20234",
  "admin_workspace_id": "01959271-1bc2-7df0-a1e1-479c65fe6171",
  "sub_workspace_id": "01959271-1bc2-7df0-a1e1-479d0dfa9cc0",
  "status": "accepted",
  "timestamp_created": "2025-03-14T02:17:21.090Z",
  "timestamp_updated": "2025-03-14T02:17:21.090Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Create workspace group member

Request

This endpoint allows you to send an invitation for a sub workspace to join the admin workspace. The sub workspace will be added as a sub workspace of the admin workspace only if the sub workspace owner accepts the invitation.

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

Bodyapplication/jsonrequired

The Workspace Group Member to create

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

curl -i -X POST \
  https://api.instantly.ai/api/v2/workspace-group-members \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sub_workspace_id": "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"
  }'

Responses

The Workspace Group Member

Bodyapplication/json

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1bc2-7df0-a1e1-479be7a20234"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1bc2-7df0-a1e1-479c65fe6171"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

Response

application/json

{
  "id": "01959271-1bc2-7df0-a1e1-479be7a20234",
  "admin_workspace_id": "01959271-1bc2-7df0-a1e1-479c65fe6171",
  "sub_workspace_id": "01959271-1bc2-7df0-a1e1-479d0dfa9cc0",
  "status": "accepted",
  "timestamp_created": "2025-03-14T02:17:21.090Z",
  "timestamp_updated": "2025-03-14T02:17:21.090Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

List workspace group member

Request

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

Query

limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10

starting_afterstring(uuid)

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084

curl -i -X GET \
  'https://api.instantly.ai/api/v2/workspace-group-members?limit=10&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Workspace Group Member

Bodyapplication/json

itemsArray of objects(Workspace Group Member)required

items[].idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1bc2-7df0-a1e1-479be7a20234"

items[].admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1bc2-7df0-a1e1-479c65fe6171"

items[].sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

items[].statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

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

Example: "2025-03-14T02:17:21.090Z"

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

Example: "2025-03-14T02:17:21.090Z"

items[].sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

items[].admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

next_starting_afterstring

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

Example: "0000-0000-0000-0000"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

Get workspace group member

Request

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

Path

idstringrequired

curl -i -X GET \
  'https://api.instantly.ai/api/v2/workspace-group-members/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Workspace Group Member

Bodyapplication/json

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1bc2-7df0-a1e1-479be7a20234"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1bc2-7df0-a1e1-479c65fe6171"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

Response

application/json

{
  "id": "01959271-1bc2-7df0-a1e1-479be7a20234",
  "admin_workspace_id": "01959271-1bc2-7df0-a1e1-479c65fe6171",
  "sub_workspace_id": "01959271-1bc2-7df0-a1e1-479d0dfa9cc0",
  "status": "accepted",
  "timestamp_created": "2025-03-14T02:17:21.090Z",
  "timestamp_updated": "2025-03-14T02:17:21.090Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Delete workspace group member

Request

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

Path

idstringrequired

curl -i -X DELETE \
  'https://api.instantly.ai/api/v2/workspace-group-members/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The deleted Workspace Group Member

Bodyapplication/json

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1bc2-7df0-a1e1-479be7a20234"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1bc2-7df0-a1e1-479c65fe6171"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1bc2-7df0-a1e1-479d0dfa9cc0"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:21.090Z"

sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

Response

application/json

{
  "id": "01959271-1bc2-7df0-a1e1-479be7a20234",
  "admin_workspace_id": "01959271-1bc2-7df0-a1e1-479c65fe6171",
  "sub_workspace_id": "01959271-1bc2-7df0-a1e1-479d0dfa9cc0",
  "status": "accepted",
  "timestamp_created": "2025-03-14T02:17:21.090Z",
  "timestamp_updated": "2025-03-14T02:17:21.090Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Get the current workspace admin workspace

Request

Get the details of the admin workspace of the current workspace

curl -i -X GET \
  https://api.instantly.ai/api/v2/workspace-group-members/admin \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json

workspace_namestringrequired

The workspace name of the admin workspace. When the current workspace has no admin workspace, the workspace name will be "Undefined".

Example: "My Workspace"

has_admin_workspacebooleanrequired

Whether the current workspace has an admin workspace

Example: true

workspace_group_member_idstring

The id of the workspace group member. You can use it to leave the admin workspace by calling the DELETE /workspace-group-members/:id endpoint

Example: "01959271-2624-7cda-9fec-e867e83167cb"

Response

application/json

{
  "workspace_name": "My Workspace",
  "has_admin_workspace": true,
  "workspace_group_member_id": "01959271-2624-7cda-9fec-e867e83167cb"
}

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

API Explorer (2.0.0)

Analytics

Account

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace

Workspace Group Member

Workspace Group Member

Create workspace group member

Request

Responses

Was this helpful?

List workspace group member

Request

Responses

Was this helpful?

Get workspace group member

Request

Responses

Was this helpful?

Delete workspace group member

Request

Responses

Was this helpful?

Get the current workspace admin workspace

Request

Responses

Was this helpful?

Workspace Member

Campaign Subsequence

Schemas