Skip to main content

Authorization

Follow this guide to create a new Apollo credential that will allow Nexla to authenticate to and exchange data with your Apollo account.
apollo_api_auth.png

Apollo

Prerequisites​

The Apollo REST API uses API key authentication. The same key is used for every endpoint, but the key's scope is determined by the endpoint access selections made when the key is created. Review the prerequisites below before creating a credential in Nexla.

API Key Access Requirements​

Generating an API key in Apollo requires admin privileges or a custom permission profile that includes API key management. Account owners can grant API key permissions from Settings > User Management if a non-admin user needs to manage keys directly.

Generate an Apollo API Key​

  1. Sign in to Apollo at app.apollo.io using an account that has admin or API management privileges.

  2. From the left navigation, click Settings, then select Integrations.

  3. Locate the Apollo API tile in the integrations directory, and click Connect.

  4. On the Apollo API page, click the API Keys tab, then click Create new key.

  5. Configure the new API key:

    • Name: Enter a descriptive name (for example, Nexla Integration) so the key can be identified later in the API key list and audit logs.

    • Description: Enter an optional description noting where the key is used and which environment it belongs to.

    • Endpoint access: Toggle on each Apollo API endpoint that the key should be allowed to call. Alternatively, enable Set as master key to grant access to every public Apollo endpoint. For Nexla integrations, the endpoints used by this connector are the People Search, Organization Search, People Enrichment, Bulk People Enrichment, and Organization Enrichment endpoints — enable any combination required by your planned data flows.

      Only enable the endpoints that are actually needed. Following the principle of least privilege limits the impact if the key is ever compromised. The endpoint access set can be edited at any time from the API Keys tab.

  6. Click Create key. Apollo displays the generated API key value once. Copy it immediately and store it in a secure secret manager — the full key value cannot be retrieved later.

  7. (Optional) Test the API key by calling the Apollo health endpoint:

    • Send a GET request to https://api.apollo.io/v1/auth/health with the header X-Api-Key: <your_api_key>. A 200 response with {"status":"ok"} confirms the key is valid.

For complete information about creating API keys, see the Apollo Create API Keys guide. For details on authentication header formats, see the Apollo Authentication reference.

Rate Limits and Credits​

Apollo enforces per-minute, per-hour, and per-day rate limits on every endpoint, and the limits scale with your Apollo plan. People Search calls do not consume credits, but Organization Search and the enrichment endpoints draw from the credit pool tied to your plan. Current usage and plan limits can be inspected at any time by calling the View API Usage Stats and Rate Limits endpoint.

Important

The Apollo API key grants access to your contact database, organization records, and any enrichment credits attached to the account. Store the key in a secure secret manager, never commit it to source control, and rotate it immediately if you suspect it has been exposed.

Create an Apollo Credential​

  • To create a new Apollo credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key​

  1. Enter the Apollo API key value generated in the prerequisites in the API Key field. Nexla stores this value as an encrypted secret and sends it to Apollo in the X-Api-Key header on every API call.

    The same API key is used for every endpoint, including both source ingestion (People Search, Organization Search) and destination calls (People Enrichment, Bulk People Enrichment, Organization Enrichment). Confirm that the endpoint access list on the key includes every Apollo endpoint that your Nexla flows will use.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.