> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Apollo OAuth

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Auth parameters validation | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `bulk-enrich-people` | Bulk enrich people by emails or IDs. Supports up to 10 people per request. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-account` | Create an account in Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-contact` | Create a contact in Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-opportunity` | Create an opportunity in Apollo | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-task` | Create a task in Apollo | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-account` | Delete or archive an account in Apollo by setting its existence\_level to none | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-contact` | Delete or archive a contact in Apollo | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-opportunity` | Archive (soft-delete) an opportunity in Apollo by marking it as closed. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `enrich-organization` | Enrich an organization by domain or Apollo ID | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `enrich-person` | Enrich a person by email or Apollo ID | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-account` | Retrieve a single account from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-contact` | Retrieve a single contact from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-opportunity` | Retrieve a single opportunity from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-accounts` | List accounts from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-contacts` | List contacts from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-opportunities` | List opportunities from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-sequences` | List sequences from Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tasks` | List tasks from Apollo | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List users (team members) in the Apollo organisation. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `remove-contact-from-sequence` | Remove or stop one or more contacts from an Apollo sequence. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-organizations` | Search Apollo organization records. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-people` | Search Apollo people records | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-account` | Update an account in Apollo | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-contact` | Update a contact in Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-opportunity` | Update an opportunity in Apollo. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-task` | Update a task in Apollo. Note: Due to OAuth limitations, the original task cannot be directly modified or deleted. A new task is created with the updated fields, and the original task should be manually deleted in the Apollo UI. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `accounts` | Sync accounts from Apollo | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `contacts` | Sync contacts from Apollo | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `opportunities` | Sync opportunities from Apollo | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `organization-search` | Sync organizations matching saved Apollo filters | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `sequences` | Sync sequences from Apollo. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `tasks` | Sync tasks from Apollo. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ✅ Not required | Free, self-signup [here](https://www.apollo.io/sign-up). |
| Paid test account | ✅ Not required | Free, self-signup [here](https://www.apollo.io/sign-up). |
| Partnership | ✅ Not required | |
| App review | ✅ Not required | Required only if you plan to list your integration on the [Apollo Marketplace](https://docs.apollo.io/docs/add-your-integration-to-apollos-marketplace). Not needed for general integration use or distribution. |
| Security audit | ✅ Not required | |

## Setup guide

**1. Register your app with Apollo**

Launch Apollo and click on *Settings* > *Integrations*. Find the *API* option and click *Connect*. Select *OAuth registration* and enter the required details.

**2. Provide App Details**

Enter the following information:

* App Name: The name of your app or product.
* App Logo: Upload the logo for your app.
* OAuth Redirect URL: The URL that users will be redirected to after they authorize your app. Use `https://api.nango.dev/oauth/callback` for the redirect URL.
* Scopes: Set the necessary scopes for your app. Apollo adds `read_user_profile` and `app_scopes` by default.

**3. Submit the Registration**

Click *Submit* to complete the registration. Once submitted, copy the generated `Client ID` and `Client secret` for use in the next steps.

**4. Next**

Follow the [*Quickstart*](https://nango.dev/docs/getting-started/quickstart.md).

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/api-integrations/apollo-basic.mdx)

## Useful links

* [How to register your Oauth Application](https://docs.apollo.io/docs/use-oauth-20-authorization-flow-to-access-apollo-user-information-partners#step-1-register-your-app-with-apollo)
* [OAuth related docs](https://docs.apollo.io/docs/use-oauth-20-authorization-flow-to-access-apollo-user-information-partners)
* [List of OAuth scopes](https://docs.google.com/spreadsheets/d/1zyJYwrgOESOYAOQIDameATCYhc3_njMaOkJ5BEM57xc/edit?usp=sharing)
* [Apollo API docs](https://docs.apollo.io/reference)
* [API rate liming](https://docs.apollo.io/reference/rate-limits)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/api-integrations/apollo-basic.mdx)

## API gotchas

*None yet, add yours!*

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/api-integrations/apollo-basic.mdx)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.