> ## 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

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (OAuth) | ✅      |
    | Credentials auto-refresh        | ✅      |
    | Auth parameters validation      | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status                         |
    | ----------------------------------------- | ------------------------------ |
    | Pre-built integrations                    | 🚫 (time to contribute: \<48h) |
    | 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>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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        | ✅                              |
  </Accordion>
</AccordionGroup>

*No pre-built syncs or actions available yet.*

<Tip>Not seeing the integration you need? [Build your own](/guides/functions/functions-guide) independently.</Tip>

## 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

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Next">
    Follow the [*Quickstart*](/getting-started/quickstart).
  </Step>
</Steps>

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

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

## 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)</Note>

## 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)</Note>