Zoom API Scopes

Details around each of the Zoom API scopes used by Fellow

Amin Mirzaee avatar
Written by Amin Mirzaee
Updated over a week ago

If you or your IT team are looking for more information about the Zoom API scopes required by Fellow, the following article can help.

Zoom APIs

Fellow uses the OAuth2 protocol in order to connect to the Zoom API on behalf of users to access the necessary data for our various Zoom integrations. OAuth2 provides built-in security mechanisms where Fellow can only access resources based on the "scopes" which it is authorized for.

There are two components for which Fellow connects to the Zoom API, and both of them are optional. They are, the Zoom Integration (which includes our in-client Zoom App), and the Zoom Chat app.

Note that if you want to create Zoom links from within Fellow when creating or editing events, you need to install the full Zoom Integration.

Zoom Integration

Below is a list of the scopes that Fellow requires for its Zoom Integration, which enables you to create Zoom Conference links for events from within Fellow, as well as use Fellow from within the Zoom Client

  • meetings:read

    Description: Get information about a Zoom meeting.

    Request Reason: Required to get information about a Zoom meeting which allows the app to open the correct note immediately when opened during a call.

  • meetings:write

    Description: Create new Zoom meetings.

    Request Reason: Required in order to create new calendar events within Fellow with Zoom set as the calendar provider, with a Zoom link generated for that event. This API is only used while the user is in-app.

  • recording:read

    Description: Get the URL to a Zoom meeting recording.

    Request Reason: This scope allows Fellow to automatically insert the URL of a Zoom meeting recording into the associated note for easy access. Fellow does not access the contents of the recording.

  • user:read

    Description: Get basic information about a Zoom User.

    Request Reason: We retrieve the Zoom user's ID and email address to inform the user about which Zoom account their Fellow account is currently connected to.

  • zoomapp:inmeeting

    Description: Allows Fellow to run as a Zoom app.

    Request Reason: This scope is required for Fellow to run as a Zoom app, and is what allows the app to be installed and opened within the Zoom client. This API is only used while the user is in-app.
    โ€‹

Zoom Chat App

Our Zoom Chat app enables users to connect Fellow with Zoom Chat. Use this if your organization uses Zoom Chat for internal communication, instead of other tools like Slack or MS Teams.

  • imchat:bot

    Description: Allows Fellow to run as a Chat bot.

    Request Reason: This scope is required for Fellow to run as a Zoom Chat bot, and is what allows the app to be installed and send messages within the Zoom client.

  • user:read:admin

    Description: Get information about all users in a Zoom account.

    Request Reason: This scope is required to retrieve the user ID value for a given user, which is then used to retrieve the list of chat channels that the user can access within Zoom when being presented with the list of options to send notes to. This API is only used while the user is in-app.

  • chat_channel:read:admin

    Description: Get the list of chat channels within a Zoom account.

    Request Reason: This allows users to select a Zoom chat channel that they have write access to, to send their Fellow meeting notes to. This API is only used while the user is in-app.

Did this answer your question?