Workspace Group Member

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

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
}

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: "019942fb-54d4-71eb-be2a-b672ff4b4bfe"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "019942fb-54d4-71eb-be2a-b673890d4267"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "019942fb-54d4-71eb-be2a-b674b28080da"

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-09-13T12:09:51.572Z"

timestamp_updatedstring(date-time)read-onlyrequired

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

sub_workspace_namenull or stringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namenull or stringread-only

The name of the admin workspace.

Example: "My Workspace"

{
  "id": "019942fb-54d4-71eb-be2a-b672ff4b4bfe",
  "admin_workspace_id": "019942fb-54d4-71eb-be2a-b673890d4267",
  "sub_workspace_id": "019942fb-54d4-71eb-be2a-b674b28080da",
  "status": "accepted",
  "timestamp_created": "2025-09-13T12:09:51.572Z",
  "timestamp_updated": "2025-09-13T12:09:51.572Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Workspace Member

A member of a workspace with associated user details

idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "019942fb-54d6-7e6b-8d47-5bec034be78a"

emailstring(email)required

Email address of the workspace member

Example: "user@example.com"

user_idstring(uuid)read-onlyrequired

User ID of the workspace member

Example: "019942fb-54d6-7e6b-8d47-5bedee549edf"

rolestringrequired

THe role of the workspace member defining their access level. While the "owner" role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.

Enum Value	Description
owner	Owner - Full access and workspace management
admin	Admin - Full access except workspace deletion
editor	Editor - Can edit but not manage workspace settings
view	View - Read-only access
client	This is a special role for users in the whitelabel (agency) view. It is not available in the API.

Example: "editor"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

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

workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "019942fb-54d6-7e6b-8d47-5beedaf6084a"

acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false

issuer_idnull or string(uuid)read-only

ID of the user who added this member to the workspace

Example: "019942fb-54d6-7e6b-8d47-5bef8d3a3a2b"

{
  "id": "019942fb-54d6-7e6b-8d47-5bec034be78a",
  "email": "user@example.com",
  "user_id": "019942fb-54d6-7e6b-8d47-5bedee549edf",
  "role": "editor",
  "timestamp_created": "2025-09-13T12:09:51.574Z",
  "workspace_id": "019942fb-54d6-7e6b-8d47-5beedaf6084a",
  "accepted": false,
  "issuer_id": "019942fb-54d6-7e6b-8d47-5bef8d3a3a2b"
}