Overview
The Apollo API enables you to connect CRMs and other third-party software to Apollo.
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.
Create a New API Key
For more technical information about the API, refer to Apollo's API reference documentation.
To create a new API key:
- Launch Apollo and click Settings > Integrations.
- Find the API option and click Connect.
- 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.
- Click API Keys to view or create new API keys. Then, click Create New Key to generate a new API Key.
- Name your API Key and add a description.
Don't Call Me Shirley!
Give your new API Key a name that provides context to its use. Choose names like
Bulk Enrichment
orContact Search
and add thorough descriptions for additional context. - Click the APIs drop-down, then click the checkboxes for the APIs you want to associate with the key. You can select multiple APIs.
- Click Create API Key.
You have now created an API key.
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.
Click the eye icon to view an API Key.
Click the copy icon to copy an API Key.
Click the trash can icon to delete an API Key.
Click Usage to see your usage statistics. You can view your email and mobile credit usage from here.
Scroll down to view your rate limits for Enhancement, Search, and Contacts APIs. You can access this information for both people and organizations.
Click Subscription to view the Apollo pricing page. You can customize your credit limit and available features from here.
Keep your API keys in a safe place. Anyone with access to these keys can take actions through your Apollo account.
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.
Click the Authorization tab, then select No Auth from the Auth Type drop-down.
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 |
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.
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.
Use the API
You are now set up. Please refer to Use the Apollo REST API to learn more about next steps.