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

# Zoom

## What's Supported

### Supported Actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill for most objects. Incremental read is supported for `recordings`, `archive_files`, `meeting_summaries`, `activities_report`, `meetings`, `users_report`, `recordings_report`, `meetings_report`, `operation_logs_report`, `meeting_activities_report`, `telephone_report`, and `upcoming_events_report`. For all other objects, a full read of the Zoom instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.zoom.us`.

<Note>
  The following objects don't support historic backfill: `users_report`, `recordings_report`, `meetings_report`, `operation_logs_report`, `meeting_activities_report`, `telephone_report`, `upcoming_events_report`, and `recordings`. By default, the last 29 days are read. To retrieve more historical data, specify higher `defaultPeriod` in your read configuration.
</Note>

### Supported Objects

The Zoom connector supports writing to and reading from the following objects:

* [activities\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/GET/report/activities) (read only)
* [archive\_files](https://developers.zoom.us/docs/api/meetings/#tag/archiving/GET/archive_files) (read only)
* [billing\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/GET/report/billing) (read only)
* [contacts\_groups](https://developers.zoom.us/docs/api/users/#tag/contact-groups/get/contacts/groups) (read and write)
* [devices](https://developers.zoom.us/docs/api/meetings/#tag/devices/GET/devices) (read and write)
* [devices\_groups](https://developers.zoom.us/docs/api/meetings/#tag/devices/get/devices/groups) (read only)
* [groups](https://developers.zoom.us/docs/api/users/#tag/groups/get/groups) (read and write)
* [h323\_devices](https://developers.zoom.us/docs/api/meetings/#tag/h323-devices/POST/h323/devices) (read and write)
* [meeting\_activities\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/meeting_activities) (read only)
* [meeting\_summaries](https://developers.zoom.us/docs/api/meetings/#tag/summaries/get/meetings/meeting_summaries) (read only)
* [meeting\_templates](https://developers.zoom.us/docs/api/meetings/#tag/templates/get/users/\{userId}/meeting_templates) (read only)
* [meetings](https://developers.zoom.us/docs/api/meetings/#tag/meetings/get/users/\{userId}/meetings) (read and write)
* [meetings\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/users/\{userId}/meetings) (read only)
* [operation\_logs\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/operationlogs) (read only)
* [phones](https://developers.zoom.us/docs/api/meetings/#tag/sip-phone/get/sip_phones/phones) (read only)
* [recordings](https://developers.zoom.us/docs/api/meetings/#tag/cloud-recording/get/users/\{userId}/recordings) (read only)
* [recordings\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/cloud_recording) (read only)
* [telephone\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/telephone) (read only)
* [tracking\_fields](https://developers.zoom.us/docs/api/meetings/#tag/tracking-field) (read and write)
* [tsp](https://developers.zoom.us/docs/api/meetings/#tag/tsp/get/users/\{userId}/tsp) (read and write)
* [upcoming\_events\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/upcoming_events) (read only)
* [upcoming\_meetings](https://developers.zoom.us/docs/api/meetings/#tag/meetings/get/users/\{userId}/upcoming_meetings) (read only)
* [users](https://developers.zoom.us/docs/api/users/#tag/users/get/users) (read and write)
* [users\_report](https://developers.zoom.us/docs/api/meetings/#tag/reports/get/report/users) (read only)
* [webinars](https://developers.zoom.us/docs/api/meetings/#tag/webinars/get/users/\{userId}/webinars) (read and write)

### Example integration

For an example manifest file of an Zoom integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/zoom/amp.yaml).

## Before You Get Started

To connect Zoom with Ampersand, you will need [a Zoom Account](#create-a-zoom-account).

Once your account is created, you'll need to configure an app in Zoom and obtain the following credentials from your app:

* Client ID
* Client Secret

You will use these credentials to connect your application to Ampersand.

### Create a Zoom Account

Here's how you can sign up for a Zoom account:

1. Go to the [Zoom Sign Up page](https://zoom.us/signup) and create an account.
2. Sign up using your preferred method.

### Creating a Zoom App

Follow the steps below to create a Zoom app and add the Ampersand redirect URL:

1. Log in to your [Zoom Marketplace](https://marketplace.zoom.us/) account.

2. Click on **Develop** in the top-right corner and select **Build App**.

3. Choose the type of app you want to create. For this integration, select **General App**.

4. Click **Create**.

5. In the **OAuth Information** section, enter the Ampersand redirect URL: `https://api.withampersand.com/callbacks/v1/oauth`.

   <br />

   <img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/5cad59a-zoom1.gif?s=59cd67c342959969da4b472d00e21277" alt="Creating Zoom App" width="1440" height="676" data-path="images/provider-guides/5cad59a-zoom1.gif" />

6. Click **Continue** and go to **Scopes**.

7. Select the applicable scopes for your app.

8. Click Continue and in the Add your app section, click Add app to finalize your app setup.

You can find the **Client ID** and **Client Secret** in the **Basic Information** section of the app. You'll use these credentials to connect your app to [Ampersand](#add-your-zoom-app-info-to-ampersand).

<img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/e6d1a69-zoom3.jpeg?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=0028f224654e031024fc12591b3089f7" alt="Ampersand Project" width="1498" height="510" data-path="images/provider-guides/e6d1a69-zoom3.jpeg" />

### Add Your Zoom App Info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create a Zoom integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/dd47b7a-Ampersand.png?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=d580aa00cc421fe14cfbab79c2e0812f" alt="Ampersand Project" width="2244" height="442" data-path="images/provider-guides/dd47b7a-Ampersand.png" />

3. Select **Provider apps**.

4. Select *Zoom* from the **Provider** list.

5. Enter the previously obtained *Client ID* in the **Client ID** field and the *Client Secret* in the **Client Secret** field.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/4669432-zoom2.gif?s=37a4b460ab56a1ca0844401f916a68f9" alt="Adding Zoom Credentials" width="788" height="478" data-path="images/provider-guides/4669432-zoom2.gif" />

6. Click **Save changes**.