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.
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.
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.
Access Your API Key
Launch Apollo and click Settings. Then, click Integrations under the "Configurations" section.
Scroll to API and click Connect.
This takes you to the API Settings page which displays your Rate Limits and contains a link to the Apollo API documentation. Click Request API Key to continue with the setup.
Copy your unique API Key to your clipboard with ctrl + c
.
Please note, you need to keep this key in a safe place. Anyone with access to this key can take actions through your Apollo account.
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.
From your Postman Workspace, click the + button to create a 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.
Next, click the Authorization tab. Click the Type drop-down and then click NO AUTH.
Click the Headers tab.
Add the following Keys and Values:
Key | Value |
---|---|
Content-Type | application/json |
Cache-Control | no-cache |
x-api-key | YOUR_API_KEY |
Click the request type drop-down and then click GET.
Click Send. This will send a request to the Apollo server to log into the API.
If your setup is correct, you will see the following message:
{
"healthy": true,
“is_logged_in”: true
}
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.