{"id":1860,"date":"2026-01-20T12:33:07","date_gmt":"2026-01-20T12:33:07","guid":{"rendered":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/?p=1860"},"modified":"2026-02-09T09:07:31","modified_gmt":"2026-02-09T09:07:31","slug":"zoom-api-usage-scopes","status":"publish","type":"post","link":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/kivicare-telemed-addon\/documentation\/integration-reference-telemed-addon\/zoom-api-usage-scopes\/","title":{"rendered":"Zoom API Usage & Scopes"},"content":{"rendered":"
\n

This section is for developers who want to understand how KiviCare interacts with the Zoom API.<\/p>\n\n\n\n

\n\n\n\n

\ud83d\udd17 Root Endpoint<\/h2>\n\n\n\n

The plugin targets the Zoom Meeting API v2<\/strong>:
https:\/\/api.zoom.us\/v2\/<\/code><\/p>\n\n\n\n

\n\n\n\n

\ud83d\udcdc Required Scopes<\/h2>\n\n\n\n

The following scopes must be enabled in your Zoom App for the plugin to function:<\/p>\n\n\n\n

    \n
  • meeting:write<\/code><\/strong>: To create, update, and delete meetings.<\/li>\n\n\n\n
  • meeting:read<\/code><\/strong>: To retrieve meeting details for verification.<\/li>\n\n\n\n
  • user:read<\/code><\/strong>: To verify the doctor’s identity during the OAuth flow.<\/li>\n\n\n\n
  • account:read<\/code><\/strong>: (S2S Only) To manage meetings across the whole account.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n

    \ud83d\udce1 Core API Requests<\/h2>\n\n\n\n

    1. Create Meeting<\/h3>\n\n\n\n
      \n
    • Method:<\/strong> POST<\/code><\/li>\n\n\n\n
    • Endpoint:<\/strong> \/users\/me\/meetings<\/code><\/li>\n\n\n\n
    • Function:<\/strong> KCTZoom::create_meeting()<\/code><\/li>\n\n\n\n
    • Key Payload:<\/strong> topic<\/code>, type (2)<\/code>, start_time<\/code>, duration<\/code>, timezone<\/code>.<\/li>\n<\/ul>\n\n\n\n

      2. Get OAuth Token<\/h3>\n\n\n\n
        \n
      • Method:<\/strong> POST<\/code><\/li>\n\n\n\n
      • Endpoint:<\/strong> https:\/\/zoom.us\/oauth\/token<\/code><\/li>\n\n\n\n
      • Function:<\/strong> KCTZoom::get_oauth_token()<\/code><\/li>\n\n\n\n
      • Parameters:<\/strong> grant_type (account_credentials)<\/code> or authorization_code<\/code>.<\/li>\n<\/ul>\n\n\n\n
        \n\n\n\n

        \u2696\ufe0f Rate Limiting<\/h2>\n\n\n\n

        Zoom enforces rate limits based on your account type.<\/p>\n\n\n\n

          \n
        • Basic\/Pro:<\/strong> 100 requests per minute.<\/li>\n\n\n\n
        • Business\/Enterprise:<\/strong> 2,000+ requests per minute.
          The plugin caches access tokens for ~55 minutes to minimize unnecessary requests.<\/li>\n<\/ul>\n<\/div>","protected":false},"excerpt":{"rendered":"

          This section is for developers who want to understand how KiviCare interacts with the Zoom API. \ud83d\udd17 Root Endpoint The plugin targets the Zoom Meeting API v2:https:\/\/api.zoom.us\/v2\/ \ud83d\udcdc Required Scopes The following scopes must be enabled in your Zoom App for the plugin to function: \ud83d\udce1 Core API Requests 1. Create Meeting 2. Get OAuth […]<\/p>\n","protected":false},"author":12,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[57],"tags":[],"class_list":["post-1860","post","type-post","status-publish","format-standard","hentry","category-integration-reference-telemed-addon"],"featured_image_src":null,"author_info":{"display_name":"wordpressadminiq","author_link":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/author\/wordpressadminiq\/"},"_links":{"self":[{"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/posts\/1860","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/comments?post=1860"}],"version-history":[{"count":2,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/posts\/1860\/revisions"}],"predecessor-version":[{"id":2966,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/posts\/1860\/revisions\/2966"}],"wp:attachment":[{"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/media?parent=1860"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/categories?post=1860"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/documentation.iqonic.design\/kivicare-wordpress\/wp-json\/wp\/v2\/tags?post=1860"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}