Overview
An application programming interface, or API, is a set of definitions and protocols for integrating application software. When you use an API, every request you send is a "call." A call can be something as simple as logging in or something more complex like completing an online transaction. For the Apollo API, calls are actions such as searching for companies, creating a contact, or updating the stage for a group of accounts. There are limits to the number of calls you can make, depending on your plan with Apollo.
Please note, all pricing tiers include some API access. However, only custom plans include advanced API access. For more on Apollo pricing tiers, please click here.
Refer to the sections below for information on how to use the Apollo REST API.
Documentation
In the API documentation, Apollo outlines which types of calls are possible and how you must configure them. This includes any needed code for your API requests. The table below highlights all available sections and actions:
| API Section | Link |
|---|---|
| Authentication | |
| People API (Records that are in Apollo's database) | |
| Organizations API | |
| Contacts API (Records that have been saved to your Apollo account) | |
| Accounts API | |
| Sequences API | |
| Misc. |
API Use Examples
Search for People
Please note, you must configure access to the Apollo API before you can follow the steps below. Please read the "Configure Access to the Apollo API" article for more information.
To use the Apollo API via Postman, click + in your workspace to add a new call.
Copy and paste the link below into the Enter request URL field:
https://api.apollo.io/v1/mixed_people/search
Next, click the drop-down and then click Post as your request type.
Please note, you can find the request types for each task in the Apollo API Documentation. Here is an example of the code from the People section of the documentation. From here, you can see what the request type for this specific task should be.
Click the Body tab. This allows you to specify the parameters of your call.
Type in the Query Parameters.
For more information about the Query Parameters, please refer to the Apollo API Documentation.
Please note, syntax is critical in defining your Query Parameters.
- Each call must begin and end with curly brackets. Each bracket must be on its own line.
- Each parameter in your call must begin and end with quotation marks. After the end quote, you must put a colon.
- Each line must end with a comma, except for the final line.
Type in your API Key.
Click Send. If you apply the Query Parameters correctly, the status will be 200 OK.
You can see the results of your "People" request in the Response field.
Please note, you may see email_not_unlocked@domain.com listed for a person's email address. This means this is not a saved contact. To unlock more email addresses, use the Enrichment Endpoint.
Search for a Saved Contact
Please note, a Saved Contact is a contact that you have enriched through Apollo. For more on enrichment, please read the "CRM Enrichment Overview" article.
Please note, you must configure access to the Apollo API before you can follow the steps below. Please read the "Configure Access to the Apollo API" article for more information.
To use the Apollo API via Postman, click + in your workspace to add a new call.
Copy and paste the following into the Enter request URL field:
https://api.apollo.io/v1/contacts/search
Next, click the drop-down and then click Post as your request type.
Please note, you can find the request types for each task in the Apollo API Documentation. Here is an example of the code from the People section of the documentation. From here, you can see what the request type for this specific task should be.
Click the Body tab. This allows you to specify the parameters of your call.
Type in the Query Parameters.
For more information about the Query Parameters, please refer to the Apollo API Documentation.
Please note, syntax is critical in defining your Query Parameters.
- Each call must begin and end with curly brackets. Each bracket must be on its own line.
- Each parameter in your call must begin and end with quotation marks. After the end quote, you must put a colon.
- Each line must end with a comma, except for the final line.
Type in your API Key.
Click Send. If you apply the example parameters correctly, the status will be 200 OK.
You can see the results of your "Saved Contacts" request in the Response field.
