OAuth

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

OAuth

OAuth authentication endpoints for connecting Google and Microsoft email accounts

Operations

Initialize google oauth

Request

Creates an OAuth session and returns the Google authorization URL. The user should be redirected to auth_url to complete the OAuth flow. Poll the status endpoint to check for completion.

curl -i -X POST \
  https://api.instantly.ai/api/v2/oauth/google/init \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
session_idstring

Session ID for polling status

Example: "abc123def456"
auth_urlstring

Google authorization URL to redirect user to

Example: "https://accounts.google.com/o/oauth2/auth?..."
expires_atstring(date-time)

Session expiry time (10 minutes from creation)

Example: "2026-01-14T12:30:00.000Z"
Response
application/json
{
  "session_id": "abc123def456",
  "auth_url": "https://accounts.google.com/o/oauth2/auth?...",
  "expires_at": "2026-01-14T12:30:00.000Z"
}

Initialize microsoft oauth

Request

Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to auth_url to complete the OAuth flow. Poll the status endpoint to check for completion.

curl -i -X POST \
  https://api.instantly.ai/api/v2/oauth/microsoft/init \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
session_idstring

Session ID for polling status

Example: "abc123def456"
auth_urlstring

Microsoft authorization URL to redirect user to

Example: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?..."
expires_atstring(date-time)

Session expiry time (10 minutes from creation)

Example: "2026-01-14T12:30:00.000Z"
Response
application/json
{
  "session_id": "abc123def456",
  "auth_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?...",
  "expires_at": "2026-01-14T12:30:00.000Z"
}

Get oauth session status

Request

Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if something went wrong. Sessions expire after 10 minutes.

Path
sessionIdstringrequired

Session ID from init response

Example: abc123def456
curl -i -X GET \
  https://api.instantly.ai/api/v2/oauth/session/status/abc123def456 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
statusstring

Current status of the OAuth session

Enum"pending""success""error""expired"
Example: "success"
emailstring

Email of the connected account (on success)

Example: "user@example.com"
namestring

Name of the account owner (on success)

Example: "John Doe"
errorstring

Error code (on error)

Example: "access_denied"
error_descriptionstring

Human-readable error description (on error)

Example: "User denied access to the application"
Response
application/json
{
  "status": "success",
  "email": "user@example.com",
  "name": "John Doe",
  "error": "access_denied",
  "error_description": "User denied access to the application"
}

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

Custom Tag Mapping

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

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

Custom Prompt Template

Custom prompt templates for creating custom prompts

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

Email Template

A campaign email template

Workspace Billing

Workspace Billing

Operations

CRM Actions

CRM related actions

Operations

Schemas