Configure Access to the Apollo REST API

Article author
Sarah Malone
Updated

Overview

An application programming interface, or API, is a set of definitions and protocols for integrating application software. The Apollo API allows you to connect CRMs and other third-party software to the platform.

 
API and Pricing

Please note, all pricing tiers include some API access. However, only custom plans include advanced API access. For more information about Apollo pricing tiers, please click here.

 
Developer Note

Please note, for more technical information about the Apollo API, developers can refer to the API Introduction article.

Refer to the sections below for instructions on how to set up and test the Apollo API.

Back to Top

Create a New API Key

Launch Apollo and click Settings. Then, click Integrations under the "Configurations" section.

Integrations

Scroll to API and click Connect.

Connect API

This takes you to the Apollo API Quickstart page. Click Get Started to read the technical documentation on how to enrich your data with an API and how to search with an API.

Get Started

Click API Keys to view or create new API Keys. Then, click + Create New Key to generate a new API Key.

Create New Key

Name your new API Key and add a description.

Name and Description

 
Don't Call Me Shirley!

Give your new API Key a name that provides context to its use. Choose names like Bulk Enrichment or Contact Search and add thorough descriptions for additional context.

Click the APIs drop-down and then click the checkboxes for the API(s) you want to associate with the key. You can select multiple APIs.

API Drop-Down

When ready, click Create API Key.

Create API

You have now created a new API Key.

Back to Top

Access Your API Keys

You can view all of your available APIs in the API Keys menu. From here, you can view, copy, and delete API keys.

API Keys

Click the Eye icon to view an API Key.

View

Click the Copy icon to copy an API Key.

Copy

Click the Trash Can icon to delete an API Key.

Delete

Click Usage on the left-hand side to see your usage statistics.

Usage Stats

You can view your Email Credit Usage and Mobile Credit Usage from here.

Usage Stats

Scroll down to view your Rate Limits for Enhancement, Search, and Contacts APIs. You can access this information for both People and Organizations.

Rate Limits

Click Subscription to view the Apollo pricing page. You can customize your credit limit and available features from here.

Pricing

Click Support to redirect to the Apollo Knowledge Base.

Support

Click Documentation to view the API-specific documentation that Apollo offers.

API Documentation

 
API Key Safety

Please note, you need to keep these keys in a safe place. Anyone with access to these keys can take actions through your Apollo account.

Back to Top

Download and Set Up Postman

Postman is a free desktop and browser API platform that simplifies the API lifecycle. There are other ways to access the Apollo API, but Apollo recommends using Postman.

Click the link below to download Postman and create an account:

https://www.postman.com/downloads/

Then, log in to Postman.

Log In

From your Postman Workspace, click the + button to create a new request.

New Request

In the GET field, copy and paste the following: https://api.apollo.io/v1/auth/health?api_key=YOUR_API_KEY_HERE

Replace YOUR_API_KEY_HERE with the API key from Apollo.

New Request

Next, click the Authorization tab. Click the Type drop-down and then click NO AUTH.

NO AUTH

Click the Headers tab.

Headers

Add the following Keys and Values:

Key Value
Content-Type application/json
Cache-Control no-cache
x-api-key YOUR_API_KEY

Keys and Values

Click the request type drop-down and then click GET.

GET

Click Send. This will send a request to the Apollo server to log into the API.

Send

If your setup is correct, you will see the following message:

{
"healthy": true, 
“is_logged_in”: true
}

Message

 
"False" Messages

Please note, if either message comes back as "False," then you are not properly set up. You may have erroneous spaces or returns after your API key, which will cause an issue. Delete them and click Send again.

You are now set up. Please read Use the Apollo REST API for more information on how to use the Apollo REST API.

Back to Top