### Get Collaboration Devices Response Example Source: https://developers.zoom.us/docs/api/users.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response when retrieving a list of collaboration devices. It includes total records and details for each device. ```json { "total_records": 30, "collaboration_devices": [ { "id": "F1C6E9DF-429E-4FA1-85DA-AC95464F3D18", "device_name": "Test Computer", "room_name": "My Personal Zoom Room", "room_user_id": "HgCQF82ZS5GiQ4x_fCx0MB", "status": "Online" } ] } ``` -------------------------------- ### Example API Request with User ID (Node.js) Source: https://developers.zoom.us/docs/api/using-zoom-apis.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This example demonstrates how to make a GET request to retrieve user details using an account-level app. Replace '{yourtokenhere}' with your actual access token. ```javascript var request = require("request"); var options = { method: "GET", // A non-existing sample userId is used in the example below. url: "https://api.zoom.us/v2/users/sjkf1234", headers: { authorization: "Bearer {yourtokenhere}", // Do not publish or share your token publicly. }, }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` -------------------------------- ### Get All Workspace Assets Response Example Source: https://developers.zoom.us/docs/api/rooms.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response when successfully retrieving a list of workspace assets. Includes asset details, next page token, and page size. ```json { "assets": [ { "name": "TV223", "asset_id": "ab31d714b3644dc79681041709aeb4ab" } ], "next_page_token": "n28bw3MswE5HKRqwrmxuR2aAoAcXZflOw72", "page_size": 15 } ``` -------------------------------- ### Get Workspace Reservations Response Example Source: https://developers.zoom.us/docs/api/rooms.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response when retrieving a workspace's reservations. This includes reservation details like ID, start and end times, status, and user ID. ```json { "from": "2021-03-18T05:41:36Z", "reservations": [ { "end_time": "2021-03-18T05:41:36Z", "id": "ebrg2b87a6uu9c678qhvsiahsc", "start_time": "2021-03-18T05:41:36Z", "timezone": "Asia/Shanghai", "topic": "My Personal Meeting Room", "user_id": "KDcuGIm1QgePTO8WbOqwIQ", "status": "reserved" } ], "to": "2021-03-18T05:41:36Z" } ``` -------------------------------- ### Zoom Rooms Configuration Example Source: https://developers.zoom.us/docs/api/rooms/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON snippet demonstrates a sample configuration for Zoom Rooms, including settings for content sharing, audio testing, and meeting auto-start/stop. ```json { "zoom_rooms": { "allow_multiple_content_sharing": true, "audio_device_daily_auto_test": true, "auto_direct_sharing": true, "auto_start_scheduled_meeting": true, "auto_stop_scheduled_meeting": true, "count_attendees_number_in_room": true, ``` -------------------------------- ### Get Session User Share Details Example Source: https://developers.zoom.us/docs/api/video-sdk.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON example demonstrates the structure of a successful response when retrieving sharing and recording details for users in a Zoom Video SDK session. It includes pagination information and details about shared content, start, and end times. ```json { "page_size": 1, "next_page_token": "1cyhUewZa419P9F8QUYURck0U3rFWB0d1H2", "users": [ { "id": "1670000000", "name": "User", "user_key": "myUserKey", "details": [ { "content": "desktop", "start_time": "2021-06-17T06:49:06Z", "end_time": "2021-06-17T06:49:35Z" } ] } ] } ``` -------------------------------- ### Download Recording Example Source: https://developers.zoom.us/docs/api/video-sdk.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This example shows how to download a recording using a provided download URL. Ensure you set your Video SDK API JWT as a Bearer token in the Authorization header. The download URL might be a redirect, so follow it if necessary. ```bash curl "{download_url}" --header "authorization: Bearer {JWT}" --header "content-type: application/json" ``` ```bash curl --location "{download_url}" ``` -------------------------------- ### Example Meeting Started Webhook Request Body Source: https://developers.zoom.us/docs/api/webhooks This is an example of the JSON payload received when a meeting starts. ```json { "event": "meeting.started", "event_ts": 1626230691572, "payload": { "account_id": "Wk9PTV9BQ0NPVU5UX0lE", "object": { "id": "1234567890", "uuid": "Wk9PTV9NRUVUSU5HX0lE", "host_id": "Wk9PTV9VU0VSX0lE", "topic": "My Meeting", "type": 8, "start_time": "2021-07-13T21:44:51Z", "timezone": "America/Los_Angeles", "duration": 60 } } } ``` -------------------------------- ### Get Account Indicators Settings Example Source: https://developers.zoom.us/docs/api/iq.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON example demonstrates the structure of the response when retrieving an account's indicators settings. It includes details like next page token, page size, and a list of indicators with their properties. ```json { "next_page_token": "R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42", "page_size": 30, "indicators": [ { "id": "9u9Sl3PBTGmAm38-7ke-Fg", "name": "indicator name", "description": "description", "category_id": "KYjRY564SzGoUsGFG7zTTw", "category_name": "Market-3", "type": "basic", "mentioned_by": "anyone", "enabled": true, "created_time": "2022-03-22T05:59:09Z", "last_modified_time": "2022-03-22T05:59:09Z", "last_modified_user_name": "user name" } ] } ``` -------------------------------- ### Zoom Room Configuration Example Source: https://developers.zoom.us/docs/api/rooms/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON object demonstrates a complete configuration for a Zoom Room, including basic settings, device profiles, and setup options like check-in/out and background images. Use this as a template for creating or updating Zoom Room configurations. ```json { "basic": { "activation_code": "1315-2376-2198-7926", "hide_room_in_contacts": true, "name": "My Personal Meeting Room", "display_name": "My Personal Meeting Room", "required_code_to_ext": true, "room_passcode": "975193018", "support_email": "contact-it@example.com", "support_phone": "18798769876", "calendar_resource_id": "u7GQ3q_zQbqJnNp02-oMjQ", "zoom_room_type": "ZoomRoom", "location_id": "49D7a0xPQvGQ2DCMZgSe7w", "tag_ids": [ "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3" ], "use_display_name_on_scheduling_display": true, "use_display_name_on_zoom_rooms_display_and_controller": true, "use_display_name_in_meetings": true, "capacity": 1, "show_room_capacity_on_the_zoom_rooms": true, "show_room_capacity_on_the_scheduling_display": true, "user_id": "Ih3wZpAjTlitZcAhuYRbxg" }, "device": { "device_profile_id": "J352JVkNRpyAgUaurxmrsh" }, "setup": { "checkin_and_checkout": { "enable": true, "checkin_and_checkout_options": { "checkin_minutes_prior_to_meeting_start_time": 600, "allowed_minutes_before_release_room_after_no_checkout": 600, "enable_new_user_checkin_notification": true, "enable_remove_recurring": true, "allowed_consecutive_missed_checkin_before_removing_room": 4 } }, "under_construction": true, "apply_background_image_to_all_displays": true, "background_image_info": [ { "display_id": "zoom_rooms_display1", "content_id": "zrd9DycNSxK6K4dEUS6z-g", "download_url": "https://zoom.us/file/Sq2mdxqRQ9eq7wmD5TFD6g?jwt=eyJ0eXAiOiJKV1QiLCJrIjoiaHRlNU05dDciLCJ6bV9za20iOiJ6bV9vMm0iLCJhbGc", "download_url_ttl": 3600 } ], "pro_device": true } } ``` -------------------------------- ### Bot Installed Event Example Source: https://developers.zoom.us/docs/api/chatbot/events.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example of the JSON payload received when a bot is installed in a Zoom account. It includes details about the account, the bot, and the user who performed the installation. ```json { "event": "", "payload": { "accountId": "", "robotJid": "", "timestamp": 1, "userId": "", "userJid": "", "userName": "" } } ``` -------------------------------- ### Get User ZAK Response Example Source: https://developers.zoom.us/docs/api/users.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON response contains the Zoom Access Key (ZAK) for an authenticated user. The ZAK is used to start or join meetings on behalf of the user and expires five minutes after receipt. ```json { "token": "eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6Im4ya1NtRmdsU2lpRnZjZWJFZTVWRFEiLCJpc3MiOiJ3ZWIiLCJzayI6IjAiLCJzdHkiOjk5LCJ3Y2QiOiJkZXYiLCJjbHQiOjAsImV4cCI6MTY1NzQ0MjI4MSwiaWF0IjoxNjQ5NjY2MjgxddkFMiiOiI0YUZaXzRJa1QzV05LMjMtSFZWSlFnIiwiY2lkIjoiIn0.RmCpEOQVUFXhtEyAaR5UsgEuAUKckcWnfWVMkH-XVGc" } ``` -------------------------------- ### Example Meeting Settings Configuration Source: https://developers.zoom.us/docs/api/users/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON object demonstrates a comprehensive configuration for meeting settings, including audio conferencing, email notifications, feature enablement, and in-meeting options. ```json { "audio_conferencing": { "toll_free_and_fee_based_toll_call": { "allow_webinar_attendees_dial": true, "enable": true, "numbers": [ { "code": "86", "country_code": "CN", "country_name": "China", "display_number": "+86 777 777 77", "number": "777 777 77" } ] }, "toll_call": { "enable": true, "numbers": [ { "code": "86", "country_code": "CN", "country_name": "China", "display_number": "+86 777 777 77", "number": "777 777 77" } ] }, "call_me_and_invite_by_phone": { "enable": true, "require_press_1_for_call_me": "auto", "allow_webinar_attendees_call_me": true, "call_out_countries": { "allowed_countries": [ { "code": "CN", "name": "China" } ], "selected_countries": [ { "code": "CN", "name": "China" } ] } }, "personal_audio_conference": true, "participant_phone_masking": { "enable": true, "masking_type": "mask_default" }, "global_dial_in_countries": { "allowed_countries": [ { "code": "CN", "name": "China" } ], "selected_countries": [ { "code": "CN", "name": "China" } ], "include_toll_free": true } }, "email_notification": { "alternative_host_reminder": true, "cancel_meeting_reminder": true, "cloud_recording_available_reminder": true, "jbh_reminder": true, "recording_available_reminder_alternative_hosts": true, "recording_available_reminder_schedulers": true, "schedule_for_reminder": true }, "feature": { "concurrent_meeting": "Basic", "large_meeting": true, "large_meeting_capacity": 500, "meeting_capacity": 500, "webinar": true, "webinar_capacity": 500, "zoom_events": true, "zoom_events_capacity": 500, "zoom_events_unlimited": true, "zoom_events_unlimited_capacities": [ 500, 100 ], "zoom_events_pay_per_attendee": true, "zoom_sessions_pay_per_attendee": true, "zoom_phone": true, "zoom_revenue_accelerator": false, "zoom_whiteboard": false, "zoom_whiteboard_plus": false, "zoom_translated_captions": false, "zoom_customer_managed_key": false, "zoom_quality_management": false, "zoom_workforce_management": false, "zoom_scheduler": false, "zoom_clips_plus": false, "zoom_mail_calendar": false, "zoom_compliance_management": false, "zoom_docs": false, "license_info_list": [ { "license_type": "ZOOM_WHITEBOARD", "license_option": 2, "subscription_id": "SUBREF-xxxxxx-xxxxxx" } ], "zoom_webinars_plus_unlimited_capacities": [ 100, 500 ], "zoom_webinars_plus_unlimited": true }, "in_meeting": { "allow_host_to_enable_focus_mode": true, "allow_users_to_delete_messages_in_meeting_chat": true, "allow_live_streaming": true, "post_meeting_feedback": true, "whiteboard": true } } ``` -------------------------------- ### Get Migrated Zoom User IDs Response Example Source: https://developers.zoom.us/docs/api/chat.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response for the GET /chat/migration/mappings/users endpoint, showing user ID mappings found and not found. ```json { "mappings_found": 15, "mappings_not_found": 5, "mappings": [ { "origin_user_id": "U04JDD2C6TE", "zm_user_id": "mXzBVHPhSlKFoIk5NJOamA" } ] } ``` -------------------------------- ### Room Connector Configuration Example Source: https://developers.zoom.us/docs/api/crc/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 A comprehensive JSON object demonstrating various settings for a room connector, including device management, provisioning, and call configurations. ```json { "device_management": false, "manage_type": "Full Management", "dynamic_ip_address": "Configured", "time_zone": "America/Chicago", "time_format": "24H", "time_server": "pool.ntp.org,time.nist.gov", "zero_touch_provisioning": false, "end_user_license_agreement": false, "join_meeting_with_dtmf": false, "always_show_join_button": false, "adhoc_join_meet_now_location": "Favorites", "label_for_ad_hoc_button": "Join Zoom Meeting", "enable_1080p": false, "unmute_on_entry": false, "default_video_layout": "Gallery", "high_quality_content_sharing": false, "enable_upcoming_meeting_reminder": false, "reminder_before_time": 10, "enable_automatic_join": false, "join_before_time": 10, "enable_automatic_leave": false, "leave_after_time": 10, "force_720p": false, "bandwidth_allocation_preference": "Off", "out_of_band_dtmf": false, "remove_audio_prompt_on_join": false, "music_mode": false, "optimize_content_sharing_for_video": false, "audio_gain_control": "Use Audio Level 2", "display_layout": "Default", "closed_caption_position": "Bottom", "additional_dtmf_command": "309", "call_rate": "384", "join_bluejeans": false, "join_webex": false, "webex_meeting_id": "Xkjnby8g9jgIth", "webex_site_name": "name", "hide_topic": false, "hide_agenda": false, "default_topic": "topic A", "default_zoom_topic": "zoom topic A", "enable_obtp": false, "exclude_all_day_event": false, "video_mute_input": "2", "sip_mode": false, "sip_call_control_registration": "enable", "h323_mode": false, "h323_gatekeeper": "enable", "call_controller_protocol_to_zoom_meeting": "SIP", "dial_using_numeric_dial_plan": "numeric", "enable_sip_tls_certificate_verification": false, "alternative_room_connector": "US", "connector_log_level": "INFO", "enable_automatic_update": true, "enable_runner_automatic_update": true, "capset_filter": "G.729AB;G.729;G.729A;AAC-LD;H.261;H.263;H.263PP;H.265;Opus;", "cisco_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "polycon_group_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "polycom_trio_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "dolby_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "polycom_debut_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "polycom_hdx_extra_provisioning": "{\"Time/TimeFormat\": \"24H\"}", "blue_tooth": false, "show_redial_button": false, "show_call_button": false, "ppcip": false, "airplay": false, "miracast": false, "apply_qos_setting": false, "dscp_audio": 60, "dscp_video": 60, "dscp_data": 60, "dscp_signalling": 60, "show_setting_menu": false, "screen_capture": false, "beta_firmware": false, "firmware_key": "key", "dev_signed_device": false, "nightly_reboot": false, "dolby_provisioning": false, "show_icons_on_the_home_screen": false, "set_zoom_cloud_sip_proxy_region": "US" } ``` -------------------------------- ### Zoom Room Configuration Example Source: https://developers.zoom.us/docs/api/rooms/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON object demonstrates how to configure basic room settings and background image setup for Zoom Rooms. It includes details like room address, passcode, support information, and background image content IDs for specific displays. ```json { "basic": { "address": "California, USA", "description": "Floor-7", "name": "State", "required_code_to_ext": true, "room_passcode": "975193018", "support_email": "contact-it@example.com", "support_phone": "18798769876", "timezone": "Asia/Shanghai" }, "setup": { "apply_background_image_to_all_displays": true, "background_image_info": [ { "display_id": "zoom_rooms_display1", "content_id": "LHMmOOYaRiOA5m5WZjXVPA" } ] } } ``` -------------------------------- ### Event Start Date Example Source: https://developers.zoom.us/docs/api/calendar.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON snippet shows how to specify the start date for an event. ```json { "start": { "date": "2020-01-01" } } ``` -------------------------------- ### List Sessions Example Source: https://developers.zoom.us/docs/api/video-sdk.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON example demonstrates the structure of a successful response when listing Video SDK sessions. It includes session details such as ID, name, start/end times, duration, user count, feature usage, and quality metrics. ```json { "from": "2021-12-01", "to": "2021-12-02", "page_size": 30, "next_page_token": "suQA5LvDBnH5No5OYD7mqpJuFzJqUOHK8U2", "sessions": [ { "id": "sfk/aOFJSJSYhGwk1hnxgw==", "session_name": "My session", "start_time": "2019-08-20T19:09:01Z", "end_time": "2019-08-20T19:19:01Z", "duration": "30:00", "user_count": 2, "has_voip": true, "has_video": true, "has_screen_share": true, "has_recording": true, "has_pstn": true, "session_key": "my_session_key", "has_session_summary": true, "audio_quality": "good", "video_quality": "good", "screen_share_quality": "good" } ] } ``` -------------------------------- ### Example Session Started Webhook Request Body Source: https://developers.zoom.us/docs/api/webhooks An example of a webhook request body for a 'session.started' event, used for signature verification. ```json { "event": "session.started", "payload": { "account_id": "{ACCOUNT_ID}", "object": { "start_time": "2022-07-27T16:56:34Z", "id":"{SESSION_ID}" } }, "event_ts": 1658940994914 } ``` -------------------------------- ### Zoom Rooms Configuration Example Source: https://developers.zoom.us/docs/api/rooms/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON object demonstrates a comprehensive configuration for a Zoom Room, including basic settings, device profiles, and setup options for check-in/out, background images, and screen lock. ```json { "basic": { "hide_room_in_contacts": true, "zoom_room_type": "ZoomRoom", "name": "My Personal Meeting Room", "display_name": "My Personal Meeting Room", "required_code_to_ext": true, "room_passcode": "975193018", "support_email": "contact-it@example.com", "support_phone": "18798769876", "calendar_resource_id": "u7GQ3q_zQbqJnNp02-oMjQ", "tag_ids": [ "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3" ], "use_display_name_on_scheduling_display": true, "use_display_name_on_zoom_rooms_display_and_controller": true, "use_display_name_in_meetings": true, "capacity": 1, "show_room_capacity_on_the_zoom_rooms": true, "show_room_capacity_on_the_scheduling_display": true }, "device": { "device_profile_id": "J352JVkNRpyAgUaurxmrsh" }, "setup": { "checkin_and_checkout": { "enable": true, "checkin_and_checkout_options": { "checkin_minutes_prior_to_meeting_start_time": 600, "allowed_minutes_before_release_room_after_no_checkout": 600, "enable_new_user_checkin_notification": true, "enable_remove_recurring": true, "allowed_consecutive_missed_checkin_before_removing_room": 4 } }, "under_construction": true, "apply_background_image_to_all_displays": true, "background_image_info": [ { "display_id": "zoom_rooms_display1", "content_id": "LHMmOOYaRiOA5m5WZjXVPA" } ], "pro_device": true, "screen_lock_pin": "123456" } } ``` -------------------------------- ### Meeting RTMS Started Request Body Example Source: https://developers.zoom.us/docs/api/rtms/events.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON payload for the meeting.rtms_started event, including meeting and stream details. ```json { "event": "", "event_ts": 1, "payload": { "meeting_uuid": "", "operator_id": "30R7kT7bTIKSNUFEuH_Qlg", "rtms_stream_id": "", "meeting_id": 1, "account_id": "", "is_original_host": true, "server_urls": "" } } ``` -------------------------------- ### Create Channel Response Example Source: https://developers.zoom.us/docs/api/video-management.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response after successfully creating a video channel. It returns the details of the newly created channel, including its ID, name, description, status, and categories. ```json { "channel_id": "iso9Dllddp39dagjLj9j", "name": "FoodieFlicks", "description": "A cinematic journey through th world of cuisine!", "status": "PUBLISHED", "categories": [ "Education" ] } ``` -------------------------------- ### Get User Details Source: https://developers.zoom.us/docs/api/using-zoom-apis.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This Node.js example demonstrates how to retrieve a user's details using a GET request to the Zoom API. ```APIDOC ## GET /users/{userId} ### Description Retrieves the details of a specific user. ### Method GET ### Endpoint https://api.zoom.us/v2/users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The ID or email address of the user. #### Query Parameters None #### Request Body None ### Request Example ```javascript var request = require("request"); var options = { method: "GET", url: "https://api.zoom.us/v2/users/sjkf1234", headers: { authorization: "Bearer {yourtokenhere}", } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` ### Response #### Success Response (200) - **id** (string) - The user's unique ID. - **first_name** (string) - The user's first name. - **last_name** (string) - The user's last name. - **email** (string) - The user's email address. - **type** (string) - The user's account type. #### Response Example { "id": "sjkf1234", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "type": "basic" } ``` -------------------------------- ### Get Subscription Versions Example Source: https://developers.zoom.us/docs/api/commerce.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON example demonstrates the expected response structure when successfully retrieving subscription changes or versions for a given subscription number. It includes details about the subscription status, dates, and a list of version-specific actions and their associated data. ```json { "subscription_number": "A-31231322", "status": "active", "start_date": "2023-01-07", "end_date": "2024-07-02", "subscription_versions": [ { "sequence": 1, "version": 1, "latest_version": true, "action": [ "create" ], "start_date": "2023-01-07", "end_date": "2024-08-01", "mrr": 1000, "currency": "USD" } ] } ``` -------------------------------- ### Get a User Source: https://developers.zoom.us/docs/api/using-zoom-apis Retrieves details for a specific user using their User ID or email address. This is an example of a GET request to the Zoom API. ```APIDOC ## Get a User ### Description Retrieves details for a specific user. This endpoint is used for account-level OAuth apps and requires the `user:read:admin` scope. ### Method GET ### Endpoint https://api.zoom.us/v2/users/{userId} ### Parameters #### Path Parameters - **userId** (string) - Required - The User ID or email address of the user. #### Query Parameters None #### Request Body None ### Headers - **authorization** (string) - Required - Bearer token for authentication. Example: `Bearer {yourtokenhere}`. ### Request Example ```javascript var request = require('request'); var options = { method: 'GET', url: 'https://api.zoom.us/v2/users/sjkf1234', // Replace with actual userId headers: { authorization: 'Bearer {yourtokenhere}', // Replace with your actual token }, }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); ``` ### Response #### Success Response (200) - **id** (string) - The user's ID. - **first_name** (string) - The user's first name. - **last_name** (string) - The user's last name. - **email** (string) - The user's email address. - **type** (string) - The user's account type. - **role_name** (string) - The user's role name. - **pmi** (integer) - The user's Personal Meeting ID. - **timezone** (string) - The user's timezone. - **verified** (integer) - Indicates if the user is verified. - **created_at** (string) - The timestamp when the user was created. - **last_login_time** (string) - The timestamp of the user's last login. - **pic_url** (string) - The URL of the user's profile picture. - **usage_type** (string) - The user's usage type. - **account_id** (string) - The ID of the account the user belongs to. - **company** (string) - The company the user is associated with. - **job_title** (string) - The user's job title. - **phone_country** (string) - The country code for the user's phone number. - **phone_number** (string) - The user's phone number. - **status** (string) - The user's account status. ``` -------------------------------- ### Create App Success Response Example Source: https://developers.zoom.us/docs/api/marketplace/ma.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example JSON response upon successful creation of an app. It includes the app's ID, name, type, creation timestamp, and credentials. ```json { "created_at": "2023-02-16T17:32:28Z", "app_id": "Bwpq5zXvQr-4PKhtYOD23g", "app_name": "My App", "app_type": "s2s_oauth", "scopes": [ "meeting:read" ], "production_credentials": { "client_id": "2J5nVOGXQXCvXoRWyGQDow", "client_secret": "BzFOrwgq1Gw6KCsyeYnmETU5e4zakGwQ" }, "development_credentials": { "client_id": "2J5nVOGXQXCvXoRWyGQDow", "client_secret": "BzFOrwgq1Gw6KCsyeYnmETU5e4zakGwQ" } } ``` -------------------------------- ### Get User Entitlements Response Example Source: https://developers.zoom.us/docs/api/marketplace.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Example response when retrieving a user's entitlements. The response includes a list of entitlement IDs. ```json { "entitlements": [ { "entitlement_id": 1 } ] } ``` -------------------------------- ### Create a new whiteboard by import Source: https://developers.zoom.us/docs/api/whiteboard.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 Creates a new whiteboard by converting supported files (Miro, Mural, Visio). Requires a file ID obtained from the file upload API. ```APIDOC ## POST /whiteboards/import ### Description Creates a new whiteboard for a user by converting Miro, Mural, or Visio files. Requires a file ID from the "Upload File for Whiteboard Import" API. ### Method POST ### Endpoint /whiteboards/import ### Parameters #### Request Body - **file_id** (string) - Required - The ID of the file to convert to a whiteboard. Supported file types: Visio (.vsdx), Miro/Mural (.pdf). Maximum file size: 100 MB. - **type** (number) - Required - The import file original type. Enum: 1 (Miro), 2 (Visio), 3 (Mural). - **collaborators** (array) - Optional - Users or team chat channels to add to a whiteboard. - **channel_id** (string) - The team chat `channel ID` to share with. - **email** (string) - The `user email` address to share with. - **role** (string) - Collaborator role type. Enum: "0" (OWNER), "1" (CO_OWNER), "2" (EDITOR), "3" (COMMENTER), "4" (VIEWER). - **owner_email** (string) - Optional - The owner email. Only available with `whiteboard:write:import:admin` scope. - **project_id** (string) - Optional - The project ID. - **skip_notifications** (boolean) - Optional - Default is false. If true, collaborators and owners will not receive notifications. - **whiteboard_name** (string) - Optional - The name of the whiteboard created by import. ### Request Example ```json { "file_id": "xBvggqyjQUal6TecwMlYwE", "type": 1, "whiteboard_name": "Q1 plan", "skip_notifications": false, "owner_email": "example@zoom.us", "collaborators": [ { "email": "user@example.com", "role": "2", "channel_id": "cabc1234567defghijkl01234" } ], "project_id": "The Project ID" } ``` ### Response #### Success Response (201) The imported file is being converted into a whiteboard. - **task_id** (string) - The unique ID for your import. Use this ID to check the import status via the Get Whiteboard Import Status endpoint. #### Response Example ```json { "task_id": "ce31de9e5a5f440bab9d60c144fd76b7" } ``` #### Error Response - **400** Bad Request (Invalid access token, Invalid File type, Exceed max file size) - **429** Too Many Requests ``` -------------------------------- ### Create Whiteboard by Import Request Example Source: https://developers.zoom.us/docs/api/whiteboard.md?ampDeviceId=d54ccf8c-64e1-4db3-a3ff-247bf94ff22c&SessionId=1780776252770 This JSON object demonstrates the request body for creating a new whiteboard by importing a file. It includes file ID, type, name, and collaborator details. ```json { "file_id": "xBvggqyjQUal6TecwMlYwE", "type": 1, "whiteboard_name": "Q1 plan", "skip_notifications": false, "owner_email": "example@zoom.us", "collaborators": [ { "email": "user@example.com", "role": "2", "channel_id": "cabc1234567defghijkl01234" } ], "project_id": "The Project ID" } ```