Module zoom

ballerinax/zoom Ballerina library



This is a generated connector for Zoom API v2.0.0 OpenAPI Specification.

The Zoom API allows developers to access information from Zoom. You can use this API to build private services or public applications on the Zoom App Marketplace. To learn how to get your credentials and create private/public applications, read our Authorization Guide. All endpoints are available via https and are located at For instance you can list all users on an account via

Configuring connector


  • Create a Zoom account by clicking the Sign Up link here: Once you activate your account, you’ll be ready to join as a developer.
  • Obtain tokens
    • Create an OAuth2.0 app by visiting Zoom App Marketplace. Then provide app related information and get client credentials. Please follow the steps in here to create and publish a zoom app successfully.
    • Generate tokens for your Zoom app following the authorization code flow. Follow the detailed steps given here
  • Please note that to set live stream details meeting host need to have a Pro license.


To use the Zoom connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

import ballerinax/zoom;

Step 2: Create a new connector instance

Configure the connection using http:OAuth2RefreshTokenGrantConfig, http:BearerTokenConfig or http:JwtIssuerConfig

zoom:ClientConfig configuration = {
    auth: {
        refreshUrl: "",
        refreshToken : "<REFRESH_TOKEN>",
        clientId : "<CLIENT_ID>",
        clientSecret : "<CLIENT_SECRET>"

zoom:Client zoomClient = check new (configuration);

Step 3: Invoke connector operation

  1. Create Zoom meeting
public function main() returns error? {
    zoom:MeetingDetails meetingDetails = {
        topic: "My Test Meeting",
        start_time: "2021-07-15T13:00:00",
        duration: 60,
        timezone: "Asia/Calcutta"
    zoom:CompoundCreateMeetingResponse meeting = check zoomClient->createMeeting("me", meetingDetails);
  1. Use bal run command to compile and run the Ballerina program.


import ballerinax/zoom;Copy


Released date: 10 months ago

Version: 1.7.1

License: Apache-2.0


Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count


Current verison: 296

Weekly downloads

Source repository


Communication/Video Conferencing


Other versions

See more...