Use the Apollo REST API

Article author
Sarah Malone
Updated

Overview

API calls 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.

 
API and Pricing

Access to Apollo's API and the number of calls your team can make is dependent on your pricing plan. Refer to Apollo's pricing page for more information.

The following sections explain how to use the Apollo REST API.

Back to Top

Before You Start: Configure API Access

You must have an Apollo API key before you can follow the steps in this article. Refer to Configure Access to the Apollo API to learn how to create an Apollo API key and test it.

Back to Top

Review the API Reference 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 following table 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.

Back to Top

Examples

Search for People

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

To search for people using the Apollo API:

  1. Create a new request in Postman. Select the POST method, then copy and paste https://api.apollo.io/v1/mixed_people/search in the URL field. Creat a new request.
  2. Click the Body tab, then enter your query parameters. Please refer to the API reference documentation to learn about all of the query parameters available for this endpoint. Define query parameters.
     
    Syntax

    Syntax is critical when 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.
  3. Click the Headers tab, then add the following keys and values:

    Content-Type: application/json Cache-Control: no-cache X-Api-Key: Enter your Apollo API key. Add header values.
  4. Click Send.

A successful request returns a 200 response status and the information you requested.

CAPTION

 
Email Placeholder

You might see email_not_unlocked@domain.com listed for a person's email address. This means they have not been saved as a contact. To unlock more email addresses, use the Enrichment endpoint.

Back to Top

Search for a Saved Contact

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

 
Saved Contacts and Enrichment

A saved contact is a contact that you have enriched through Apollo. For more info on enrichment, check out CRM Enrichment Overview.

To search for a saved contact using the Apollo API:

  1. Create a new request in Postman. Select the POST method, then copy and paste https://api.apollo.io/v1/contacts/search in the URL field. Create a request.
  2. Click the Body tab, then enter your query parameters. Please refer to the API reference documentation to learn about all of the query parameters available for this endpoint. Define query parameters.
     
    Syntax

    Syntax is critical when 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.
  3. Click the Headers tab, then add the following keys and values:

    Content-Type: application/json Cache-Control: no-cache X-Api-Key: Enter your Apollo API key. Add header values.
  4. Click Send.

A successful request returns a 200 response status and the information you requested.

Review the response.

Back to Top