Zoom API Usage & Scopes

This section is for developers who want to understand how KiviCare interacts with the Zoom API.

🔗 Root Endpoint

The plugin targets the Zoom Meeting API v2:
https://api.zoom.us/v2/

📜 Required Scopes

The following scopes must be enabled in your Zoom App for the plugin to function:

• meeting:write: To create, update, and delete meetings.
• meeting:read: To retrieve meeting details for verification.
• user:read: To verify the doctor’s identity during the OAuth flow.
• account:read: (S2S Only) To manage meetings across the whole account.

📡 Core API Requests

1. Create Meeting

• Method: POST
• Endpoint: /users/me/meetings
• Function: KCTZoom::create_meeting()
• Key Payload: topic, type (2), start_time, duration, timezone.

2. Get OAuth Token

• Method: POST
• Endpoint: https://zoom.us/oauth/token
• Function: KCTZoom::get_oauth_token()
• Parameters: grant_type (account_credentials) or authorization_code.

⚖️ Rate Limiting

Zoom enforces rate limits based on your account type.

• Basic/Pro: 100 requests per minute.
• Business/Enterprise: 2,000+ requests per minute.
  The plugin caches access tokens for ~55 minutes to minimize unnecessary requests.

Next: Database Mappings Table