> For the complete documentation index, see [llms.txt](https://docs.harmony.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.harmony.io/integrations/saas-applications/apollo-io.md).

# Apollo.io

Discover Apollo.io teammates and track their sign-ins and per-user sales activity across your Apollo workspace

Apollo.io is a sales intelligence and engagement platform. Connecting Apollo.io to Harmony with an API key gives IT and finance teams a live roster of Apollo users and a per-user record of who is actually working in Apollo - so inactive seats are visible before renewal.

#### What the Apollo.io integration enables

| Capability              | Description                                                                                                                                                             |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| User Discovery          | Surface every teammate in your Apollo workspace in Harmony's software inventory, and whether each is active or deactivated                                              |
| Role Discovery          | With a master key: admins flagged for access reviews, for users on the same Apollo permission profile as the admin the API key acts as (see Roles and seat types below) |
| Login Tracking          | Record each user's most recent Apollo sign-in                                                                                                                           |
| Activity Tracking       | Record, per user and per day, emails sent, calls made, tasks completed and meetings attended                                                                            |
| Inactive Seat Detection | A user with no Apollo sign-in, call or completed task for 90 days shows as inactive on the Apollo.io application page                                                   |
| Multi-Instance Support  | Connect more than one Apollo workspace, each as its own Apollo.io instance                                                                                              |

#### Prerequisites

* **Apollo admin**: only an Apollo admin, or a user whose permission profile allows it, can create API keys
* **An Apollo API key**: a master key is recommended. A key with only the three endpoints listed in Step 1 also connects, but leaves out roles, the plan and the workspace name
* **Harmony Account**: Active Harmony workspace

#### Connect Apollo.io to Harmony

**Step 1: Create an API Key**

1. Log in to Apollo and go to **Settings** > **Integrations** > **API Keys**
2. Click **Create new key**
3. Enter a name and description (e.g. `Harmony Integration`)
4. Toggle **Set as master key** (recommended). To limit the key to what Harmony needs instead, leave it off and under **APIs** select `api/v1/users/search`, `api/v1/users/api_profile` and `api/v1/reports/sync_report`
5. For the integration type, select **Private** (a key used only by your own Apollo workspace)
6. Click **Create API key**
7. Click **Copy** and store the key somewhere safe

{% hint style="warning" %}
Apollo shows the full key only on this screen. If you lose it you can regenerate it with the **⟳** button under **Settings** > **API Keys**, but regenerating invalidates the key Harmony holds - delete the Apollo.io instance in Harmony and create it again with the new key afterwards.
{% endhint %}

{% hint style="info" %}
**Why a master key:** Apollo returns your workspace name, plan and seats, and permission profiles (roles) only to master keys; they are not endpoints a key can be limited to. A key with just the three endpoints above collects users, sign-ins and activity without them. A master key can also call Apollo endpoints that create and change records, but Harmony only ever reads - see Permissions Explained below.
{% endhint %}

**Step 2: Navigate to Integrations**

1. Log in to your Harmony dashboard
2. Go to **Settings** > **Integrations**
3. Find **Apollo.io** under **SaaS Applications** (or search for it by name) and click its card

**Step 3: Enter Credentials**

1. If an Apollo.io instance is already connected, click **+ Create instance**
2. Enter an **Instance name** (required), for example the name of your Apollo workspace
3. Paste your **API key**
4. Click **Connect**

Harmony makes test calls to the three endpoints above before saving. If Apollo rejects the key, reports that it does not include one of them, or refuses the request because of the workspace's plan, Harmony tells you which, and nothing is saved. If Apollo cannot be reached or is rate limiting at that moment, the key is saved without the check.

{% hint style="info" %}
If your Apollo workspace uses **IP allowlisting** (Apollo Settings > Users & teams > Security), Harmony's addresses must be on the list or every call is refused.
{% endhint %}

#### Disconnect Apollo.io from Harmony

1. Log in to your Harmony dashboard
2. Go to **Settings** > **Integrations**
3. Find **Apollo.io** under **SaaS Applications** and click the integration card
4. Click the delete (trash) icon next to the instance you want to remove
5. Confirm the deletion when prompted

Once disconnected, Harmony stops syncing data from Apollo. Previously synced data remains available in Harmony. You can also delete the key in Apollo at **Settings** > **Integrations** > **API Keys**.

#### What Harmony Syncs

**From Apollo.io:**

* Teammates - Apollo user ID, email address, name, job title, creation date, time zone, manager and whether the user is active or deactivated
* Each teammate's **most recent sign-in**, recorded as a login event each time it advances
* Per-user daily activity, as reported by Apollo Analytics:
  * **Phone calls**
  * **Tasks completed**
  * **Emails sent** - includes emails Apollo sent automatically from the user's sequences
  * **Meetings attended** - Apollo counts a meeting that has ended as attended unless someone marks it otherwise

**Also, with a master key** (see Step 1):

* Your **workspace name**, used as the name of the Apollo.io instance in Harmony
* Each teammate's **role**, only for teammates on the same permission profile as the admin the API key acts as - see Roles and seat types below
* Your workspace's **plan**: the seat product, seats purchased and assigned, the current billing cycle and its price

{% hint style="info" %}
**What counts as active:** a user is active if they signed in to Apollo, made a call or completed a task in the last 90 days. Emails sent and meetings attended are recorded as usage but do not count toward activity: Apollo sends sequence emails and counts booked meetings as attended on the user's behalf, even if they never open Apollo.

Apollo keeps only each user's latest sign-in time, not a login history. Someone who stays signed in for weeks on one session records one login, not one per day.
{% endhint %}

**Roles and seat types**

Roles are collected only with a master key; with any other key every user is listed with the `member` role and no role label.

Apollo runs every API-key request as your workspace's longest-standing active admin. Apollo's roster lists only an opaque permission profile ID for each user, and when Harmony looks a profile up, Apollo answers with that admin's own profile whichever profile is asked for. Harmony therefore records a profile only for users on the same profile as that admin - usually Apollo's **Admin** profile:

* Those users show the profile name (for example `Admin`) as their role, and are marked as an admin when the profile is Apollo's Admin or Billing and seat manager profile, or a custom profile allowed to manage users, permission profiles or billing
* Every other user is listed with the `member` role and no role label. This means the role was not collected, not that the user is confirmed to be a non-admin: an admin on a different profile, such as Billing and seat manager, also shows as `member`

Seat types are recorded only on Apollo's Free plan, where every active user holds a free seat, and only when Harmony can read the plan. On a paid plan Harmony does not assign per-user seat types, and deactivated users never get one.

{% hint style="info" %}
**Sync cadence:**

* The user inventory and sign-in times are refreshed every 6 hours
* Activity is collected every 6 hours and covers only days that have fully closed, so a day's activity appears in Harmony about a day and a half to two days after it ends. Days follow the Apollo time zone of the admin the API key acts as
* The first sync reads the last 90 days of activity
  {% endhint %}

#### Permissions Explained

Harmony authenticates with a single Apollo **API key**, used read-only.

| What Harmony calls          | Why                                                                                                      |
| --------------------------- | -------------------------------------------------------------------------------------------------------- |
| `GET /users/api_profile`    | Identifies the Apollo workspace the key belongs to, so data lands on the right application               |
| `GET /users/search`         | The teammate roster, including each user's latest sign-in time                                           |
| `POST /reports/sync_report` | Apollo Analytics, grouped by user and day - the source of the activity data                              |
| `GET /teams/{id}`           | Your workspace name, plan, purchased and assigned seats and billing cycle. Answered for master keys only |
| `GET /permission_sets/{id}` | The name and type of a permission profile, for roles. Answered for master keys only                      |

Things to know about the key:

* A master key can call every Apollo API endpoint, including ones that create or change records; a key with only the three endpoints above cannot. Either way Harmony only reads; it never creates, modifies or removes Apollo users, contacts, sequences or settings
* Apollo runs every API-key request as your workspace's longest-standing active admin. Because Harmony only reads, nothing is created or changed in that admin's name
* Apollo's rate limits are shared by every key in the workspace. Harmony's calls are small: a few roster pages, one team read and one read per permission profile in use every 6 hours, and about one analytics query a day per 1,000 users
* Harmony does not store the content of emails, calls or tasks - only the daily counts

#### Use Cases

<details>

<summary>Inactive Seat Review</summary>

See which Apollo users have not signed in, made a call or completed a task in the last 90 days and reclaim their seats before renewal. Apollo deactivation is done in Apollo (Settings > Users & teams > Users); Harmony shows you who to deactivate.

</details>

<details>

<summary>Adoption</summary>

Compare how many Apollo users send emails, make calls, complete tasks and attend meetings against how many hold a seat, by team or over time.

</details>

<details>

<summary>Offboarding</summary>

Confirm Apollo access has been removed when sales staff leave, as part of Harmony offboarding workflows. After the next inventory sync, a deactivated Apollo user no longer shows as an active user in Harmony.

</details>

#### Troubleshooting

<details>

<summary>Harmony refuses the key when connecting</summary>

**Possible causes:**

* The key's scope does not include one of `api/v1/users/api_profile`, `api/v1/users/search` or `api/v1/reports/sync_report`; Harmony names the missing one. Create a new key with **Set as master key** enabled, or with the three endpoints selected
* Apollo refused the request because of the workspace's plan. Harmony shows Apollo's own message when this happens
* The key was regenerated or deleted in Apollo

</details>

<details>

<summary>Every user shows as a member, and the instance is not named after the Apollo workspace</summary>

The key is not a master key. Apollo returns roles, the plan and the workspace name to master keys only. Create a key with **Set as master key** enabled, then delete the Apollo.io instance in Harmony and create it again with the new key.

Even then, only users on the same permission profile as the admin the key acts as get a role label - everyone else still shows as a member. See Roles and seat types above.

</details>

<details>

<summary>Users sync but no activity appears</summary>

**Possible causes:**

* The key's scope does not include `api/v1/reports/sync_report`
* Apollo Analytics is not available on the workspace's plan
* Nobody has sent, called, completed a task or attended a meeting in the window yet
* The days you are looking at are too recent. A day's activity appears about a day and a half to two days after it ends. The first sync reads the previous 90 days, so older activity appears soon after connecting

</details>

<details>

<summary>A user I expect to be active shows as inactive</summary>

Only sign-ins, calls and completed tasks count toward activity. Apollo records one sign-in time per user and refreshes it when the user logs in again, so a user who stays signed in on one long session records no new login. If they also only send emails (including sequence emails), attend meetings, read Apollo, review dashboards or use the Chrome extension, without making calls or completing tasks, nothing keeps them active.

</details>

<details>

<summary>Everything stopped after an Apollo admin regenerated the key</summary>

Regenerating a key in Apollo invalidates the previous value. Delete the Apollo.io instance in Harmony and create it again with the new value.

</details>

#### Data & Privacy

* Harmony reads teammate profiles, permission profiles, your workspace name, plan and seat counts, and daily activity counts only. It does not read prospect or contact data, email content, call recordings or transcripts
* The API key is stored encrypted and used only for the calls listed above
* Harmony's calls consume no Apollo credits


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.harmony.io/integrations/saas-applications/apollo-io.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
