Configure Access to the Apollo REST API

Article author
Sarah Malone
Updated

Overview

The Apollo API enables you to connect CRMs and other third-party software to Apollo.

 
API and Pricing

Access to Apollo's API is dependent on your pricing plan. Refer to Apollo's pricing page for more information. If you need help upgrading, reach out to the Apollo sales team for guidance.

The following sections show how to set up and test the Apollo API.

Back to Top

Create a New API Key

 
Developer Resources

For more technical information about the API, refer to Apollo's API reference documentation.

To create a new API key:

  1. Launch Apollo and click Settings > Integrations.
  2. Find the API option and click Connect. Connect API
  3. On 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
  4. Click API Keys to view or create new API keys. Then, click Create New Key to generate a new API Key. Create New Key
  5. Name your 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.

  6. Click the APIs drop-down, then click the checkboxes for the APIs you want to associate with the key. You can select multiple APIs. API Drop-Down
  7. Click Create API Key.

You have now created an API key.

Back to Top

Access Your API Keys

You can view all of your available APIs in the API Keys tab. 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 to see your usage statistics. You can view your email 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

 
API Key Safety

Keep your API keys in a safe place. Anyone with access to these keys can take actions through your Apollo account.

Back to Top

Test the Apollo API

There are many options for testing the API. For this article, Apollo is going to use Postman, but the same information can be applied to your preferred testing methods.

To get started, create a new request in Postman. Select the GET method, then copy and paste https://api.apollo.io/v1/auth/health in the URL field.

New Request

Click the Authorization tab, then select No Auth from the Auth Type drop-down.

NO AUTH

Click the Headers tab, then add the following keys and values:

Key Value
Content-Type application/json
Cache-Control no-cache
X-Api-Key Enter your Apollo API key

Keys and Values

Click Send. This sends a request to the Apollo server to log into the API. If your setup is correct, you will receive the following JSON response:


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

If both values in the response are true, you are ready to use the API.

 
False Response

If either object has a value of False, check your request details again. Delete any erroneous spaces or returns after your API key. Once you are sure your request is formatted appropriately, click Send to try again.

Back to Top

Use the API

You are now set up. Please refer to Use the Apollo REST API to learn more about next steps.

Back to Top