Create an API Key

Overview

Apollo API enables you to build integrations with Apollo, connect CRMs and other third-party software, enrich your records with Apollo data, and more.

To use Apollo API, you need to create an API key. When you create a key, you choose which endpoints it can call. There are two kinds of keys.

• Scoped key (default): You pick the specific endpoints the key can access, and it only works for those. If you use it to call an endpoint you didn't select, Apollo returns a 403 error.
• Master key: Selecting Set as master key gives a key access to every endpoint. A few endpoints, like create call records, only work with a master key and return a 403 without one. Treat a master key like a password: it can take any API action your Apollo account allows.

Check out the following sections to create either kind of API key.

Create an API Key

To create an API key:

1. Launch Apollo and click Settings > Integrations > API Keys.
2. Click Create new key.

3. Give the API key a name that provides context to the users who manage your API keys, and add thorough descriptions. Then select each API endpoint that you want the key to have access to. Alternatively, toggle Set as master key to select all endpoints.

💡

A Key Decision

Apollo recommends you use a scoped key limited to the endpoints your integration calls. Create a master key only when an endpoint requires one.

4. Select the integration type that describes how the integration will be used:

   • Private: Custom-built and used by one Apollo customer.
   • Public: Available to any Apollo customer to connect and use.
   • Reseller: Provides Apollo data to end users without requiring each end user to connect their own Apollo account. Learn how to add your integration to the Apollo Marketplace.

5. Click Create API key.

6. Apollo shows the full API key. Click Copy, and paste it to a secure location.

You have now created an API key. With your API key created, you're ready to test Apollo API.

Manage API Keys

You can regenerate or delete existing API keys in Apollo.

To manage your API keys:

1. Launch Apollo and go to Settings > API Keys.
2. Click API keys.
3. Click ⟳ to regenerate and copy the new API key.

4. Click Delete to permanently delete an API key. Any integrations currently using the API key fail.

You have now managed your API keys on Apollo.

🚧

Safety is Key

Keep your API keys in a safe and secure place, and be careful with whom you share API access. Anyone with access to API keys may be able to take action in your Apollo account.