Audit Log
/
Audit Log

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

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

Audit Log

Audit log records for tracking system activities

idstring(uuid)read-onlyrequired
Example: "682bbddb4b4704d2a1e8b1b0"
timestampstring(date-time)read-onlyrequired

When the activity occurred

Example: "2025-05-19T23:25:15.242Z"
organization_idstring(uuid)read-onlyrequired

Organization ID associated with the activity

Example: "0196eadd-a06a-751e-b608-e803c08aee0a"
activity_typenumberread-onlyrequired

Type of activity performed

Enum ValueDescription
1

User login

2

Lead deletion

3

Campaign deletion

4

Campaign launch

5

Campaign pause

6

Account addition

7

Account deletion

8

Lead moved

9

Lead added

10

Lead merged

Example: 1
ip_addressstringread-onlyrequired

IP address from which the activity was performed

Example: "127.0.0.1"
from_apibooleanread-onlyrequired

Whether the activity was performed via API

Example: false
user_agentstringread-only

User agent of the client that performed the activity

Example: "Mozilla/5.0..."
user_idstring(uuid)read-only

ID of the user who performed the activity

Example: "0196eadd-a06a-751e-b608-e804576d1967"
affected_countnumberread-only

Number of items affected by the activity

Example: 1
campaign_idstring(uuid)read-only

Associated campaign ID if applicable

Example: "0196eadd-a06a-751e-b608-e805b0cae173"
subsequence_idstring(uuid)read-only

Associated subsequence ID if applicable

Example: "0196eadd-a06a-751e-b608-e80664ddd181"
list_idstring(uuid)read-only

Associated list ID if applicable

Example: "0196eadd-a06a-751e-b608-e8073e1aca60"
audit_metadataobjectread-only

Metadata about the audit log

user_namestringread-only

Name of the user who performed the activity

Example: "John Doe"
{
  "id": "682bbddb4b4704d2a1e8b1b0",
  "timestamp": "2025-05-19T23:25:15.242Z",
  "organization_id": "0196eadd-a06a-751e-b608-e803c08aee0a",
  "activity_type": 1,
  "user_agent": "Mozilla/5.0...",
  "user_id": "0196eadd-a06a-751e-b608-e804576d1967",
  "ip_address": "127.0.0.1",
  "from_api": false,
  "affected_count": 1,
  "campaign_id": "0196eadd-a06a-751e-b608-e805b0cae173",
  "subsequence_id": "0196eadd-a06a-751e-b608-e80664ddd181",
  "list_id": "0196eadd-a06a-751e-b608-e8073e1aca60",
  "audit_metadata": {},
  "user_name": "John Doe"
}

List audit log

Request

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

Query
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring

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
activity_typenumber

Filter by activity type

Example: activity_type=1
searchstring

Search term to filter logs

Example: search=login
curl -i -X GET \
  'https://api.instantly.ai/api/v2/audit-logs?activity_type=1&limit=10&search=login&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Audit Log

Bodyapplication/json
itemsArray of objects(Audit Log)required
items[].​idstring(uuid)read-onlyrequired
Example: "682bbddb4b4704d2a1e8b1b0"
items[].​timestampstring(date-time)read-onlyrequired

When the activity occurred

Example: "2025-05-19T23:25:15.242Z"
items[].​organization_idstring(uuid)read-onlyrequired

Organization ID associated with the activity

Example: "0196eadd-a06a-751e-b608-e803c08aee0a"
items[].​activity_typenumberread-onlyrequired

Type of activity performed

Enum ValueDescription
1

User login

2

Lead deletion

3

Campaign deletion

4

Campaign launch

5

Campaign pause

6

Account addition

7

Account deletion

8

Lead moved

9

Lead added

10

Lead merged

Example: 1
items[].​ip_addressstringread-onlyrequired

IP address from which the activity was performed

Example: "127.0.0.1"
items[].​from_apibooleanread-onlyrequired

Whether the activity was performed via API

Example: false
items[].​user_agentstringread-only

User agent of the client that performed the activity

Example: "Mozilla/5.0..."
items[].​user_idstring(uuid)read-only

ID of the user who performed the activity

Example: "0196eadd-a06a-751e-b608-e804576d1967"
items[].​affected_countnumberread-only

Number of items affected by the activity

Example: 1
items[].​campaign_idstring(uuid)read-only

Associated campaign ID if applicable

Example: "0196eadd-a06a-751e-b608-e805b0cae173"
items[].​subsequence_idstring(uuid)read-only

Associated subsequence ID if applicable

Example: "0196eadd-a06a-751e-b608-e80664ddd181"
items[].​list_idstring(uuid)read-only

Associated list ID if applicable

Example: "0196eadd-a06a-751e-b608-e8073e1aca60"
items[].​audit_metadataobjectread-only

Metadata about the audit log

items[].​user_namestringread-only

Name of the user who performed the activity

Example: "John Doe"
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: "0196eadd-bb22-7b4b-8080-14b23d9fbe0e"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0196eadd-bb22-7b4b-8080-14b23d9fbe0e"
}

Schemas