Connecting to Apollo

Authentication

To authenticate to Apollo.io, you can use OAuth 2.0 authentication to connect to your own data or to allow other users to connect to their data.

Using OAuth Authentication

OAuth requires registering an application with Apollo.io to obtain client credentials. To authenticate using OAuth, you need to obtain your OAuth credentials from the Apollo.io developer console.

You can then connect by setting the AuthScheme to OAuth and providing your OAuth credentials:

• AuthScheme: Set this to OAuth.
• OAuthClientId: Set this to your application's client ID.
• OAuthClientSecret: Set this to your application's client secret.
• Scope: Set this to specify the access scope for your application.

Example Connection String

Profile=Apollo.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Available Tables

The Apollo API Profile provides access to comprehensive sales intelligence and engagement data across 23 specialized tables:

• AccountStages - Query account pipeline stage definitions and workflow configurations.
• Accounts - Access company account records with organization details, contact information, and CRM integration data.
• CompleteOrganizationInfo - Access comprehensive organization profiles with detailed business intelligence.
• Contacts - Query individual contact records with personal information, communication history, and relationship data.
• ContactStages - Access contact pipeline stage definitions and progression tracking.
• Deals - Retrieve deal pipeline data with stages, values, and associated contact information.
• DealStages - Query deal pipeline stage definitions and sales process workflows.
• EmailAccounts - Query email account configurations and integration settings.
• EmailStats - Access email campaign performance metrics and analytics data.
• Lists - Access contact and account list definitions with member data.
• Organizations - Query organization records including company details, funding information, and technology usage.
• OrganizationEnrichment - Access enriched organization data with detailed company information.
• OrganizationJobPostings - Access job posting data from organization career pages.
• OutreachEmails - Access email outreach campaign data with delivery status and engagement metrics.
• People - Search and retrieve people/contacts from Apollo.io database with advanced filtering capabilities.
• PeopleEnrichment - Enrich people records with additional contact information and social data.
• Sequences - Query email sequence configurations and automation workflows.
• Tasks - Access task management data with completion status, deadlines, and linked records.
• Users - Access workspace user information, permissions, and activity data.

Usage Examples

Query all account stages:

SELECT * FROM AccountStages

Search accounts by organization name:

SELECT * FROM Accounts WHERE QOrganizationName = 'Tesla'

Query complete organization information:

SELECT * FROM CompleteOrganizationInfo WHERE Id = 'org_123456'

Search contacts by keyword:

SELECT * FROM Contacts WHERE QKeyWord = 'marketing manager'

Query all contact stages:

SELECT * FROM ContactStages

Query all deal records:

SELECT * FROM Deals

Query all deal stages:

SELECT * FROM DealStages

Query all email accounts:

SELECT * FROM EmailAccounts

Query email statistics:

SELECT * FROM EmailStats WHERE Id = '1234'

Query all contact lists:

SELECT * FROM Lists

Search organizations by name and employee count:

SELECT * FROM Organizations WHERE QOrganizationName = 'Microsoft' AND OrganizationNumEmployeesRanges = '10000'

Enrich organization data by domain:

SELECT * FROM OrganizationEnrichment WHERE Domain = 'salesforce.com'

Query job postings for an organization:

SELECT * FROM OrganizationJobPostings WHERE OrganizationId = 'org_123456'

Search outreach emails by keywords and date range:

SELECT * FROM OutreachEmails WHERE QKeywords = 'product demo' AND EmailerMessageDateRange >= '2024-01-01'

Search people by job title and location:

SELECT * FROM People WHERE PersonLocations = 'San Francisco' AND PersonSeniorities = 'director,vp'

Enrich person data with email waterfall:

SELECT * FROM PeopleEnrichment WHERE RunWaterfallEmail = true AND Domain = 'salesforce.com'

Search sequences by name:

SELECT * FROM Sequences WHERE QName = 'Sales Outreach'

Query all task records:

SELECT * FROM Tasks

Query all users:

SELECT * FROM Users

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
AuthScheme	The scheme used for authentication. Accepted entries are OAuth or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
CallbackURL	Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only).
InitiateOAuth	Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	Scope(s) to use when authenticating, that control access to specific information.