Zoom

This documentation for the Zoom integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Zoom, visit our connection instructions.

Version

This integration utilizes the Zoom User API v2.

Base URL

The base URL used for all Zoom API endpoints:

https:​//api.zoom.us/v2/

---

Authentication & Authorization

The DataGrail Zoom integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Zoom API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Zoom integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Access
user:read:user:admin	✅
group:read:group:admin	✅
meeting:read:list_meetings:admin	✅
webinar:read:list_webinars:admin	✅
cloud_recording:read:list_user_recordings:admin	✅
phone:read:user:admin	✅
phone:read:user_setting:admin	✅
phone:read:list_recordings:admin	✅
phone:read:list_voicemails:admin	✅
phone:read:list_call_logs:admin	✅

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/users	Verify connection and access to the requested scopes
GET	https:​//zoom.us/oauth/authorize	Request authorization
POST	https:​//zoom.us/oauth/token	Get and refresh access token

---

Limits

Limits in Zoom are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Zoom integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for User email using the Data Subject email address.
2. If a user match is found, DataGrail will extract all objects related to the user, including the following:

Match Found

• Retrieve a user's settings by user ID
• Retrieve a user's meetings by user ID
• Retrieve a user's webinars by user ID
• Retrieve a user's recordings by user ID
• Get the user's Zoom phone profile by user ID
• Retrieve the Zoom Phone profile settings of a user by user ID
• Retrieve a user's Zoom phone call logs by user ID
• Retrieve a user's Zoom Phone voicemails by user ID
• Retrieve a user's Zoom Phone recordings by user ID

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/phone/users/user_id	Returns a user's Zoom phone profile
GET	/phone/users/user_id/call_logs	Returns a user's Zoom phone call logs
GET	/phone/users/user_id/recordings	Gets a user's Zoom Phone recordings
GET	/phone/users/user_id/settings	Returns the Zoom Phone profile settings of a user
GET	/phone/users/user_id/voice_mails	Returns a user's Zoom Phone voicemails
GET	/users/email	Verify a user's email by the Data Subject email
GET	/users/user_id/meetings	List a meeting host user's scheduled meetings
GET	/users/user_id/recordings	Lists all cloud recordings for a user
GET	/users/user_id/settings	Retrieve a user's settings by user ID
GET	/users/user_id/webinars	List all the webinars scheduled by or on behalf a webinar host

---