Connecting to Instantly

Using API Key Authentication

Instantly uses API keys to authenticate requests. You can find or create your API key in the Instantly workspace settings under API & Webhooks.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Instantly API key (Bearer token for API v2).

Example connection string

Profile=C:\profiles\Instantly.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The Instantly API Profile provides access to email outreach and campaign data across 28 tables:

• Accounts - Email sending accounts connected to the Instantly workspace.
• AccountCampaignMappings - Campaigns associated with a specific email account.
• AccountDailyAnalytics - Daily analytics per email account showing sending activity and engagement metrics.
• ApiKeys - API keys configured in the workspace.
• AuditLogs - Audit log entries for workspace activity tracking.
• BackgroundJobs - Asynchronous background job records for bulk operations.
• BlockListEntries - Blocked email addresses and domains.
• CampaignAnalytics - Aggregate analytics for campaigns.
• CampaignDailyAnalytics - Daily campaign analytics showing sending and engagement activity per day.
• Campaigns - Email outreach campaign definitions and configurations.
• CampaignSubsequences - Subsequences attached to parent campaigns.
• CustomTagMappings - Associations between custom tags and resources.
• CustomTags - Custom tags for organizing workspace resources.
• DfyEmailAccountOrders - Done-for-you email account orders and provisioning records.
• EmailVerifications - Email address verification status records.
• Emails - Individual email messages sent, received, and tracked in campaigns.
• InboxPlacementAnalytics - Individual inbox placement test results per recipient.
• InboxPlacementTests - Inbox placement test configurations and results.
• LeadLabels - Labels for categorizing leads by interest or status.
• LeadLists - Named lists for organizing leads.
• Leads - Contacts tracked in Instantly campaigns.
• PhoneNumbers - Provisioned phone numbers available in the workspace CRM.
• WebhookEvents - Events delivered to configured webhooks.
• Webhooks - Webhook endpoint configurations.
• Workspace - Current workspace configuration and settings.
• WorkspaceBillingPlan - Workspace billing plan and subscription details.
• WorkspaceGroupMembers - Members of workspace sub-groups.
• WorkspaceMembers - Members of the Instantly workspace.

Usage Examples

AccountCampaignMappings:

SELECT * FROM AccountCampaignMappings WHERE Email = '[email protected]'

AccountDailyAnalytics:

SELECT * FROM AccountDailyAnalytics

Accounts:

SELECT * FROM Accounts

AuditLogs:

SELECT * FROM AuditLogs

BackgroundJobs:

SELECT * FROM BackgroundJobs

BlockListEntries:

SELECT * FROM BlockListEntries

CampaignAnalytics:

SELECT * FROM CampaignAnalytics

CampaignDailyAnalytics:

SELECT * FROM CampaignDailyAnalytics

CampaignSendingStatus:

SELECT * FROM CampaignSendingStatus WHERE Id = 'campaign-uuid'

CampaignSubsequences:

SELECT * FROM CampaignSubsequences WHERE ParentCampaign = 'campaign-uuid'

Campaigns:

SELECT * FROM Campaigns

CustomTagMappings:

SELECT * FROM CustomTagMappings

CustomTags:

SELECT * FROM CustomTags

DfyEmailAccountOrders:

SELECT * FROM DfyEmailAccountOrders

EmailVerifications:

SELECT * FROM EmailVerifications WHERE Email = '[email protected]'

Emails:

SELECT * FROM Emails

InboxPlacementAnalytics:

SELECT * FROM InboxPlacementAnalytics WHERE TestId = 'test-uuid'

InboxPlacementTests:

SELECT * FROM InboxPlacementTests

LeadLabels:

SELECT * FROM LeadLabels

LeadLists:

SELECT * FROM LeadLists

Leads:

SELECT * FROM Leads WHERE Id = 'lead-uuid'

PhoneNumbers:

SELECT * FROM PhoneNumbers

SuperSearchEnrichment:

SELECT * FROM SuperSearchEnrichment WHERE ResourceId = 'resource-uuid'

Workspace:

SELECT * FROM Workspace

WorkspaceBillingPlan:

SELECT * FROM WorkspaceBillingPlan

WorkspaceGroupMembers:

SELECT * FROM WorkspaceGroupMembers

WorkspaceMembers:

SELECT * FROM WorkspaceMembers

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	The API Key in your Instantly account.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT