{"openapi":"3.0.0","info":{"title":"Scheduler","description":"The Scheduler APIs let you programmatically interact with [Zoom Scheduler](https://developers.zoom.us/docs/zoom-scheduler/) features. They allow you to schedule, manage, and retrieve details about meetings, webinars, and other events on the Zoom platform. With powerful tools for integration, these APIs streamline event management and automate workflows in external applications.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/scheduler/routing/forms/{formId}/response/{responseId}":{"get":{"tags":["Routing Forms"],"summary":"get routing response","description":"Returns the response submitted for a routing form.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:routing`,`scheduler:read:routing:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Getroutingresponse","parameters":[{"name":"formId","in":"path","description":"The identifier of the routing form.","required":true,"schema":{"type":"string","example":"ry2u3fgqnbo2oqbp20ffos0860"}},{"name":"responseId","in":"path","description":"The identifier of the response to a particular routing form.","required":true,"schema":{"type":"string","example":"ka2u3fgqnbo2oqbp20ffos0860"}}],"responses":{"200":{"description":"If succeeded, this method returns the routing response details in the response body. The response body will include basic routing form information, the questions in the form and the corresponding awnsers, and the final results after submitting the response, which could be one of the following: a URL, a text or a booking link. ","content":{"application/json":{"schema":{"type":"object","properties":{"booked":{"type":"boolean","description":"Indicating whether a final booking was made after submitting the response","example":false},"booking_link":{"type":"string","description":"The booking link that the returned as the result of submitting the form. It could be empty because result type could be URL or text.","example":"https://xyz.com/d/0bedzp07/roundrobin"},"created_time":{"type":"string","description":"The time that the response was submitted.","example":"2025-05-01T16:49:55.801Z"},"creator_email":{"type":"string","description":"The creator of the response.","example":"abc@def.com"},"form_id":{"type":"string","description":"The form ID.","example":"s91lg8lb3mhuj4itgtjnd3f440"},"questions_and_answers":{"maxItems":20,"type":"array","description":"The questions and answers in the response.","items":{"type":"object","properties":{"answers":{"maxItems":100,"type":"array","description":"This field could be text, email address, single choice or multiple choices, depending on questions types. All values are stored as string.","items":{"type":"string","example":"50"}},"question_id":{"type":"string","description":"The question ID.","example":"17y6gve91og6ftr8qo86vlfz70"},"question_content":{"type":"string","description":"The question content asked in the form.","example":"such as \"hobbit\", \"email\", \"age\""}}}},"result_type":{"type":"string","description":"The type of result returned after submitting the response.","example":"could be one of \"event\", \"text\" or \"url\"","enum":["event","text","url"]},"result_value":{"type":"string","description":"The value of result returned after submitting this response. Itcould be a booking schedule or a URL or a text. ","example":"{\"appointmentId\":\"h7z59a55xmkamethclg2huhja0\",\"user\":\"d/0bedzp07\"}"}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  NotFound \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  InternalErr \n\n "}},"security":[{"openapi_oauth":["scheduler:read","scheduler:read:admin","scheduler:read:routing","scheduler:read:routing:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read","scheduler:read:admin"],"x-granular-scopes":["scheduler:read:routing","scheduler:read:routing:admin"]}}},"/scheduler/routing/responses":{"get":{"tags":["Routing Forms"],"summary":"list account routing response","description":"Returns a list of routing responses across all routing forms under the account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:routing`,`scheduler:read:routing:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"list_account_routing_response","responses":{"200":{"description":"If succeeded, this method returns a list of routing responses across all routing forms under the account.","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","description":"The list of routing responses across all routing forms under the account.","items":{"type":"object","properties":{"booked":{"type":"boolean","description":"Indicating whether a final booking was made after submitting the response.","example":false},"booking_link":{"type":"string","description":"The booking link that the returned as the result of submitting the form. It could be empty because result type could be URL or text.","example":"https://xyz.com/d/0bedzp07/roundrobin"},"created_time":{"type":"string","description":"The time that the response was submitted.","example":"2025-05-01T16:49:55.801Z"},"creator_email":{"type":"string","description":"The creator of the response.","example":"abc@def.com"},"form_id":{"type":"string","description":"The routing form ID that this response belongs to.","example":"9eafbbgl5lfsmw11wh8vcxoqc0"},"response_id":{"type":"string","description":"The response ID.","example":"s91lg8lb3mhuj4itgtjnd3f440"},"questions_and_answers":{"maxItems":20,"type":"array","description":"The questions and answers in the response.","items":{"type":"object","properties":{"answers":{"maxItems":100,"type":"array","description":"This field could be text, email address, single choice or multiple choices, depending on questions types. All values are stored as string.","items":{"type":"string","example":"50"}},"question_id":{"type":"string","description":"The question ID.","example":"17y6gve91og6ftr8qo86vlfz70"},"question_content":{"type":"string","description":"The question content asked in the form.","example":"such as \"hobbit\", \"email\", \"age\""}}}},"result_type":{"type":"string","description":"The type of result returned after submitting the response.","example":"event","enum":["event","text","url"]},"result_value":{"type":"string","description":"The value of result returned after submitting this response. It could be a booking schedule or a URL or a text.","example":"{\"appointmentId\":\"h7z59a55xmkamethclg2huhja0\",\"user\":\"d/0bedzp07\"}"},"form_name":{"type":"string","description":"The name of routing form.","example":"Height information statistics"}}}},"next_page_token":{"type":"string","description":"The token to retrieve the next page of results. If empty, no more results are available.","example":"MTc0NjEyMzQ1NjAwMA=="}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  NotFound \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  InternalErr \n\n "}},"security":[{"openapi_oauth":["scheduler:read","scheduler:read:admin","scheduler:read:routing","scheduler:read:routing:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read","scheduler:read:admin"],"x-granular-scopes":["scheduler:read:routing","scheduler:read:routing:admin"]}}},"/scheduler/analytics":{"get":{"tags":["analytics"],"summary":"Report analytics","description":"Generates the scheduler analytics report.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:analytics`,`scheduler:read:analytics:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"report_analytics","parameters":[{"name":"to","in":"query","description":"The upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. It must be an RFC3339 timestamp with mandatory time zone offset. For example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If `timeMin` is set, `timeMax` must be greater than `timeMin`.","required":false,"schema":{"type":"string","example":"2024-02-01T00:00:00Z"}},{"name":"from","in":"query","description":"The lower bound (exclusive) for an event's end time from which to filter. Optional. The default is not to filter by end time. It must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds can be provided but are ignored. If `timeMax` is set, `timeMin` must be smaller than `timeMax`.","required":false,"schema":{"type":"string","example":"2024-01-01T00:00:00Z"}},{"name":"time_zone","in":"query","description":"The time zone in the response. The default is the time zone of the calendar. Optional. ","required":false,"schema":{"type":"string","example":"America/Los_Angeles"}},{"name":"user_id","in":"query","description":"The specific user's web user ID. Default is \"me\". Use \"all\" to query for analytics with respect to all members under that account. ","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80 or all"}}],"responses":{"200":{"description":"If successful, this method returns the scheduler analytics or the user ID or account ID provided.","content":{"application/json":{"schema":{"type":"object","properties":{"event_distribution_by_duration":{"maxItems":5,"type":"array","description":"The event distribution by duration.","items":{"type":"object","properties":{},"description":"The event name and its duration in minutes.","example":{"Event distribution by duration":[{"30":65},{"45":15},{"60":35}]}}},"last_n_days":{"type":"object","properties":{"scheduled_events_created":{"type":"integer","description":"The number of created scheduled events.","example":10},"scheduled_events_completed":{"type":"integer","description":"The number of completed scheduled events.","example":10},"schedules_created":{"type":"integer","description":"The number of created schedules.","example":10},"scheduled_events_canceled":{"type":"integer","description":"The number of cancelled scheduled events.","example":10},"scheduled_events_rescheduled":{"type":"integer","description":"The number of rescheduled scheduled events.","example":10},"schedules_canceled":{"type":"integer","description":"The number of cancelled schedules.","example":10},"one_to_one":{"type":"integer","description":"The number of \"one to one\" type schedules.","example":10},"any_host_available":{"type":"integer","description":"The number of \"any host available\" type schedules.","example":10},"one_off_meeting":{"type":"integer","description":"The number of \"one-off\" type schedules.","example":10},"all_host_available":{"type":"integer","description":"The number of \"all host available\" type schedules.","example":10},"meeting_poll":{"type":"integer","description":"The number of \"meeting poll\" type schedules.","example":10},"one_to_many":{"type":"integer","description":"The number of \"one to many\" type schedules.","example":10}},"description":"The stats of the last N days.","example":"\"last_n_days\":{{\"created_scheduled_events\":65},{\"completed_scheduled_events\":34},{\"created_schedules\":20},{\"cancelled_scheduled_events\":14},{\"rescheduled_scheduled_events\":8},{\"cancelled_schedules\":3},{\"one_to_one\":10},{\"any_host_available\":5},{\"one_off_meeting\":2},{\"all_host_available\":1},{\"meeting_poll\":1},{\"one_to_many\":1}}"},"popular_schedules":{"maxItems":5,"type":"array","description":"The most popular schedules in the given time range.","example":{"Popular schedules":[{"Test 1-1":5},{"Test 1-to-many":4},{"Test any host available":3}]},"items":{"type":"object","description":"The scheduled event's name and booked times."}},"popular_time_of_week":{"maxItems":24,"type":"array","description":"The distribution of number of events scheduled in a week.","example":{"Popular times (day of week)":[{"Fri":20},{"Wed":16},{"Thu":11},{"Tue":8},{"Mon":6},{"Sat":3},{"Sun":1}]},"items":{"type":"object","description":"day abbreviation"}},"popular_time_of_day":{"maxItems":7,"type":"array","description":"The distribution of number of events scheduled in a day.","example":{"Popular times (hour of day)":[{"11":16},{"12":6},{"16":3}]},"items":{"type":"object","description":"The hour index."}},"previous_period":{"type":"object","properties":{"scheduled_events_created":{"type":"integer","description":"The number of created scheduled events.","example":10},"scheduled_events_completed":{"type":"integer","description":"The number of completed scheduled events.","example":10},"schedules_created":{"type":"integer","description":"The number of created schedules.","example":10},"scheduled_events_canceled":{"type":"integer","description":"The number of cancelled scheduled events.","example":10},"scheduled_events_rescheduled":{"type":"integer","description":"The number of rescheduled scheduled events.","example":10},"schedules_canceled":{"type":"integer","description":"The number of cancelled schedules.","example":10},"one_to_one":{"type":"integer","description":"The number of \"one to one\" type schedules.","example":10},"any_host_available":{"type":"integer","description":"The number of \"any host available\" type schedules.","example":10},"one_off_meeting":{"type":"integer","description":"The number of \"one-off\" type schedules.","example":10},"all_host_available":{"type":"integer","description":"The number of \"all host available\" type schedules.","example":10},"meeting_poll":{"type":"integer","description":"The number of \"meeting poll\" type schedules.","example":10},"one_to_many":{"type":"integer","description":"The number of \"one to many\" type schedules.","example":10}},"description":"the stats of the previous period with a length of also N. Last N day is counting from today and backtrace N days. Previous period is counting from N days ago and back tracking another N days","example":"\"previous_period\":{{\"created_scheduled_events\":65},{\"completed_scheduled_events\":34},{\"created_schedules\":20},{\"cancelled_scheduled_events\":14},{\"rescheduled_scheduled_events\":8},{\"cancelled_schedules\":3},{\"one_to_one\":10},{\"any_host_available\":5},{\"one_off_meeting\":2},{\"all_host_available\":1},{\"meeting_poll\":1},{\"one_to_many\":1}}"},"users_with_least_events":{"maxItems":5,"type":"array","description":"The users with the least scheduled events.","example":{"Users with the least events":[{"Dan Smith":5},{"Allan Swift":10}]},"items":{"type":"object","description":"The user's display name and number of scheduled events."}},"users_with_most_events":{"maxItems":5,"type":"array","description":"The users with the most scheduled events.","example":{"Users with the most events":[{"Dan Smith":65},{"Allan Swift":20}]},"items":{"type":"object","description":"The user's display name and number of scheduled events."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read","scheduler:read:admin","scheduler:read:analytics","scheduler:read:analytics:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read","scheduler:read:admin"],"x-granular-scopes":["scheduler:read:analytics","scheduler:read:analytics:admin"]}}},"/scheduler/availability":{"get":{"tags":["availability"],"summary":"List availability","description":"Returns the availability schedules of the given user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_availability`,`scheduler:read:list_availability:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"list_availability","parameters":[{"name":"page_size","in":"query","description":"The maximum number of availability returned on one result page.","required":false,"schema":{"type":"integer","example":250}},{"name":"next_page_token","in":"query","description":"The token that specifies which result page to return.","required":false,"schema":{"type":"string","example":"Cj8KLwotCgsI3ujvqgYQgIXUGxIeChwKGjBzNzAyZWVtbjBzOTdlZXFhNXE1NWg4ZWJtGgwIzIPVrAYQwM3WrAPAPgE="}},{"name":"user_id","in":"query","description":"The return of the specific user's availability.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"responses":{"200":{"description":"Successful availability of the schedule query result of given user.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":" The token for a later to retrieve only the entries that have changed since this result was returned. It's omitted if further results are available, in which case `nextPageToken` is provided.","example":"Cj8KLwotCgsI3ujvqgYQgIXUGxIeChwKGjBzNzAyZWVtbjBzOTdlZXFhNXE1NWg4ZWJtGgwIzIPVrAYQwM3WrAPAPgE="},"items":{"type":"array","description":"array[User Availability Schedule]","items":{"type":"object","properties":{"availability_id":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"},"default":{"type":"boolean","example":true},"name":{"type":"string","example":"The working hours."},"owner":{"type":"string","description":"The owner's ID.","example":"easonfsxsysks3lgchitiw@scheudler.zoom.us"},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sunday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}}},"time_zone":{"type":"string","example":"Asia/Shanghai"}}}}},"description":"The availability of the schedule query result of given user."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:list_availability","scheduler:read:list_availability:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:list_availability","scheduler:read:list_availability:admin"]}},"post":{"tags":["availability"],"summary":"Insert availability","description":"Inserts a user availability schedule. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:availability`,`scheduler:write:availability:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"insert_availability","requestBody":{"description":"In the request body, it supplies an availability resource properties.","content":{"application/json":{"schema":{"required":["name","time_zone"],"type":"object","properties":{"availability_id":{"type":"string","description":"The unique ID of availability.","readOnly":true,"example":"x3h1u4id4liffdyszsp8kpxl80"},"default":{"type":"boolean","description":"The default availability schedule in use."},"owner":{"type":"string","description":"the owner's ID.","readOnly":true,"example":"easonfsxsysks3lgchitiw@scheudler.zoom.us"},"name":{"minLength":1,"type":"string","description":"The name of this availability schedule.","example":"Working hours"},"time_zone":{"type":"string","description":"The timezone for which this availability schedule originates.","example":"Asia/Shanghai"},"segments":{"type":"array","description":"The date on which the rule needs to be applied outside of the availability rule.","items":{"required":["end","start"],"type":"object","properties":{"end":{"type":"string","description":"This field indicates the end date to override.","example":"2024-01-08T09:00:00Z"},"start":{"type":"string","description":"This field indicates the start date to override.","example":"2024-01-07T09:00:00Z"}},"description":"The date interval to override."}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The rules of this availability schedule."}},"description":"The availability schedule set by the user."}}}},"responses":{"201":{"description":"If successful, this method returns a availability resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"boolean","description":"The default availability schedule in use.","example":false},"availability_id":{"type":"string","description":"The unique ID of the availability.","example":"x3h1u4id4liffdyszsp8kpxl80"},"name":{"type":"string","description":"The name of this availability schedule.","example":"Working hours"},"owner":{"type":"string","description":"An URI reference to a user.","example":"easonfsxsysks3lgchitiw"},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The rules of this availability schedule."},"time_zone":{"type":"string","description":"The timezone for which this availability schedule originates.","example":"Asia/Shanghai"},"segments":{"type":"array","description":"The date on which the rule needs to be applied outside of the availability rule.","items":{"type":"object","description":"The date interval to override."}}},"description":"The availability schedule set by the user."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:write:availability","scheduler:write:availability:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:write:availability","scheduler:write:availability:admin"]}}},"/scheduler/availability/{availabilityId}":{"get":{"tags":["availability"],"summary":"Get availability ","description":"Returns the availability schedule of the given UUID.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:availability`,`scheduler:read:availability:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"get_availability","parameters":[{"name":"availabilityId","in":"path","description":"The UUID of the availability schedule.","required":true,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}}],"responses":{"200":{"description":"If successful, this method returns an availability resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"availability_id":{"type":"string","description":"The unique ID of availability.","example":"x3h1u4id4liffdyszsp8kpxl80"},"default":{"type":"boolean","description":"The default availability schedule in use.","example":true},"name":{"type":"string","description":"The name of this availability schedule.","example":"Working hours"},"owner":{"type":"string","description":"The owner's ID.","readOnly":true,"example":"easonfsxsysks3lgchitiw@scheudler.zoom.us"},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The rules of this availability schedule."},"time_zone":{"type":"string","description":"The timezone for which this availability schedule originates.","example":"Asia/Shanghai"}},"description":"The availability schedule set by the user."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:availability","scheduler:read:availability:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:availability","scheduler:read:availability:admin"]}},"delete":{"tags":["availability"],"summary":"Delete availability","description":"Removes a user's availability.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:availability`,`scheduler:delete:availability:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"delete_availability","parameters":[{"name":"availabilityId","in":"path","description":" The UUID of the availability schedule.","required":true,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}}],"responses":{"204":{"description":"If successful, this method returns an empty response body."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:delete:availability","scheduler:delete:availability:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:delete:availability","scheduler:delete:availability:admin"]}},"patch":{"tags":["availability"],"summary":"Patch availability","description":"Adjusts the availability schedule content of the given UUID.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:availability`,`scheduler:update:availability:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"patch_availability","parameters":[{"name":"availabilityId","in":"path","description":"The UUID of the availability schedule.","required":true,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}}],"requestBody":{"description":"In the request body, supply availability resource properties.","content":{"application/json":{"schema":{"required":["name","time_zone"],"type":"object","properties":{"default":{"type":"boolean","description":"The default availability schedule in use."},"name":{"minLength":1,"type":"string","description":"The name of this availability schedule.","example":"Working hours"},"time_zone":{"type":"string","description":"The timezone for which this availability schedule originates.","example":"Asia/Shanghai"},"segments":{"type":"array","description":"The date on which the rule needs to be applied outside of the availability rule.","items":{"required":["end","start"],"type":"object","properties":{"end":{"type":"string","description":"The end date to override.","example":"2024-01-08T09:00:00Z"},"start":{"type":"string","description":"The start date to override.","example":"2024-01-07T09:00:00Z"}},"description":"The date interval that needs to overridden."}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The rules of this availability schedule."}},"description":"The availability schedule set by the user."}}}},"responses":{"204":{"description":"If successful, this method returns an empty response body."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:update:availability","scheduler:update:availability:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:update:availability","scheduler:update:availability:admin"]}}},"/scheduler/attendee":{"post":{"tags":["scheduled events"],"summary":"Create a booking for a schedule slot","description":"Books a time slot on an existing schedule in Zoom Scheduler. This endpoint creates a new booking, attendee, or event by specifying the schedule, start time, duration, booker information, and optional guests or custom field responses.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:scheduled_event`,`scheduler:write:scheduled_event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"create_booking","parameters":[{"name":"user","in":"query","description":"The user slug identifier to filter available time slots for a specific host or team member. Format: `t/` followed by the user identifier, for example `t/x0ghart`. **Required** if the schedule object contains a `user` field — pass the exact value from that field. Omit if the schedule has no `user` field.","required":false,"schema":{"type":"string","example":"booking-john-time"}}],"requestBody":{"description":"The booking details including the schedule to book, time slot, booker information, and optional configuration.","content":{"application/json":{"schema":{"required":["booker","duration","location_configuration","schedule_id"],"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of the schedule or scheduling page on which to create the booking.","example":"s4xg14dfoxu4t7avyd8453vr90"},"duration":{"maximum":720,"minimum":1,"type":"integer","description":"The duration of the booking in minutes.","example":30},"booker":{"required":["email","first_name","last_name"],"type":"object","properties":{"email":{"type":"string","description":"The booker's email address.","format":"email","example":"test@gmail.com"},"first_name":{"type":"string","description":"The booker's first name.","example":"John"},"last_name":{"type":"string","description":"The booker's last name.","example":"Doe"},"time_format":{"type":"string","description":"The booker's preferred time display format.","example":"12h","enum":["12h","24h"]},"phone_number":{"type":"string","description":"The booker's phone number for SMS reminders. Must be a valid phone number (for example, `+1 888-888-8888`).","example":"+1 888-888-8888"}},"description":"The information of the person making the booking, also known as the invitee."},"tracking":{"type":"object","properties":{"utm_campaign":{"type":"string","description":"The UTM campaign parameter used to track a campaign.","example":"bio_consultation"},"utm_source":{"type":"string","description":"The UTM source parameter that identifies where the traffic originates.","example":"linkedin"},"utm_medium":{"type":"string","description":"The UTM medium parameter that identifies the type of input. For example, Cost Per Click (CPC), social media, affiliate, or QR code.","example":"social"},"utm_content":{"type":"string","description":"The UTM content tracking parameter.","example":"profile_link"},"utm_term":{"type":"string","description":"The UTM term parameter used to track keywords.","example":"b2b_leads"},"salesforce_person":{"type":"string","description":"The 15 or 18-digit Salesforce ID.","example":"0035g00000AbCdEAAZ"},"salesforce_related":{"type":"string","description":"The 15 or 18-digit Salesforce ID.","example":"0015g00000AbCdEAAZ"}},"additionalProperties":{"type":"string"},"description":"Optional tracking parameters for analytics or attribution purposes, such as UTM parameters or custom tracking data.","example":{"utm_source":"website","utm_campaign":"spring_promo"}},"location_configuration":{"required":["kind"],"type":"object","properties":{"kind":{"type":"string","description":"The type of meeting location or method.","example":"physical"},"location":{"maxLength":1024,"type":"string","description":"The physical location or address for offline meetings. Leave empty for virtual meetings.","example":"NYC Office, 123 Main St"},"phone_number":{"type":"string","description":"The phone number for Zoom Phone meetings. Leave empty for non-phone meetings.","example":"+1234567890"},"additonal_info":{"type":"string","description":"Additional information about the meeting location.","example":"No need to knock"}},"description":"The location or meeting method configuration for this specific booking. This overrides or specifies the meeting location details."},"questions_and_answers":{"type":"array","description":"The booker's questions and answers.","items":{"type":"object","properties":{"question":{"type":"string","description":"A question for the booker. The string is case-sensitive and must exactly match the question.","example":"Please share your location information with us"},"answer":{"type":"string","description":"The booker's response to the question.","example":"San Jose"},"position":{"type":"string","description":"The position of the question in relation to others.","example":"0"}},"description":"A specific question and answer pair."}},"start_date_time":{"type":"string","description":"The start date and time of the booking in ISO 8601 format. For example, `YYYY-MM-DDTHH:mm:ss.sssZ`.","example":"2026-04-07T08:00:00Z"},"time_zone":{"type":"string","description":"The time zone identifier of the user or location, represented in the IANA Time Zone Database format (for example, `America/Los_Angeles`).","example":"America/Los_Angeles"}}}}}},"responses":{"201":{"description":"Booking created successfully. Returns the full booking event object with attendee details, assigned host, and computed fields.","content":{"application/json":{"schema":{"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of the schedule or scheduling page this booking belongs to.","example":"s4xg14dfoxu4t7avyd8453vr90"},"summary":{"type":"string","description":"The name or title of the schedule that was booked.","example":"test workflow2222"},"type":{"type":"string","description":"The schedule type. `one` for individual or `multiple` for multi-host.","example":"one","enum":["one","multiple"]},"status":{"type":"string","description":"The status of the booking.","example":"confirmed","enum":["confirmed","cancelled"]},"start_date_time":{"type":"string","description":"The start date and time in ISO 8601 format.","example":"2026-04-07T08:00:00Z"},"end_date_time":{"type":"string","description":"The end date and time in ISO 8601 format.","example":"2026-04-07T08:30:00Z"},"duration":{"type":"number","description":"The duration of the booking in minutes.","example":30},"capacity":{"type":"number","description":"The maximum number of invitees per slot for this schedule.","example":1},"attendees":{"type":"array","description":"The list of attendees, bookers, or invitees for this booking.","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the attendee.","example":"nzsb8soiwevala67283933le80"},"email":{"type":"string","description":"The attendee's email address.","format":"email","example":"elianedarkd9@gmail.com"},"first_name":{"type":"string","description":"The attendee's first name.","example":"aaa"},"last_name":{"type":"string","description":"The attendee's last name.","example":"aaa"},"display_name":{"type":"string","description":"The attendee's full display name, computed from the first name and last name.","example":"aaa aaa"},"booker":{"type":"boolean","description":"Whether this attendee is the person who made the booking.","example":true},"response_status":{"type":"string","description":"The attendee's RSVP response status.","example":"accepted","enum":["accepted","declined","tentative","needs_action"]},"time_format":{"type":"string","description":"The attendee's preferred time display format.","example":"12h","enum":["12h","24h"]},"time_zone":{"type":"string","description":"The attendee's time zone.","example":"Asia/Shanghai"},"created":{"type":"string","description":"The timestamp when the attendee record was created.","format":"date-time","example":"2026-04-07T06:21:10.907Z"}}}},"assigned_to":{"type":"array","description":"The list of host display names assigned to this booking. For individual schedules, this contains the single host. For round-robin or multi-host schedules, it contains the assigned hosts.","items":{"type":"string","description":"The display name of an assigned host.","example":"guts zhu"}},"location":{"type":"string","description":"The meeting location or physical address for offline meetings. Empty for virtual meetings.","example":"NYC Office, 123 Main St"},"location_additional_info":{"type":"string","description":"Additional information about the meeting location.","example":"No need to knock"},"location_kind":{"type":"string","description":"The type of meeting location or method for this booking.","example":"physical"},"tracking":{"type":"array","description":"The tracking fields returned from the request body.","items":{"type":"object","properties":{"tracking_key":{"type":"string","description":"Corresponds one-to-one with the field names under the `tracking` field in the request body.","example":"utm_campaign"},"tracking_value":{"type":"string","description":"Corresponds one-to-one with the field values under the `tracking` field in the request body.","example":"bio_consultation"}}}},"event_id":{"type":"string","description":"The unique identifier of the created scheduled event.","example":"b5p14d5ghjvb4t7a9hq8473rv60"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request body or time slot has already been scheduled.\n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unregistered user or expired token.\n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The service is unavailable.\n\n "}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:write:scheduled_event","scheduler:write:scheduled_event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:write:scheduled_event","scheduler:write:scheduled_event:admin"]}}},"/scheduler/events":{"get":{"tags":["scheduled events"],"summary":"List scheduled events","description":"Returns a list of all scheduled events.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_scheduled_events`,`scheduler:read:list_scheduled_events:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"list_scheduled_events","parameters":[{"name":"to","in":"query","description":"The upper bound (exclusive) for an event's start time from which to filter.","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"from","in":"query","description":"The lower bound (exclusive) for an event's end time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"page_size","in":"query","description":"The maximum number of events returned on one result page.","required":false,"schema":{"type":"integer","example":250}},{"name":"order_by","in":"query","description":"This field indicates the start time or the time when the event has been updated.","required":false,"schema":{"type":"string","example":"startTime"}},{"name":"time_zone","in":"query","description":"The time zone in the response.","required":false,"schema":{"type":"string","example":"UTC"}},{"name":"next_page_token","in":"query","description":"The token that specifies which result page to return.","required":false,"schema":{"type":"string","example":"ffffffff97c5b97f_53slvrhet2n0xkxurl5ybgde40"}},{"name":"show_deleted","in":"query","description":"Whether to include deleted events (with status equals `cancelled`) in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"event_type","in":"query","description":"Whether to return the pending events.","required":false,"schema":{"type":"string","example":"pending","enum":["pending"]}},{"name":"user_id","in":"query","description":"The return of the specific user's scheduled event. It's only for admin","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}},{"name":"search","in":"query","description":"This field returns search results from meeting ID or summary.","required":false,"schema":{"type":"string","example":"94777886776"}},{"name":"team_id","in":"query","description":"The team ID of which the user belongs.","required":false,"schema":{"type":"string","example":"erayolgveb4bmtzn1ubx1lxe70"}},{"name":"account_level","in":"query","description":"An optional field. The default is false. False means only list scheduled events of specify user, or it means list scheduled events of all users below current account.","required":false,"schema":{"type":"boolean","example":true}},{"name":"created_from","in":"query","description":"The lower bound (exclusive) for an event's create time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"created_to","in":"query","description":"The upper bound (exclusive) for an event's create time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"updated_from","in":"query","description":"The lower bound (exclusive) for an event's update time from which to filter.","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"updated_to","in":"query","description":"The upper bound (exclusive) for an event's update time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}}],"responses":{"200":{"description":"If successful, this method returns a response body with the following structure:","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The token to access the next page of this result.","example":"ffffffff97c5b97f_53slvrhet2n0xkxurl5ybgde40"},"items":{"type":"array","description":"The event collection.","items":{"type":"object","properties":{"event_id":{"type":"string","description":"The unique identifier of event.","example":"woft7torlatbw8ek24bmit5k60"},"schedule_id":{"type":"string","description":"The unique identifier of schedule.","example":"ygfx661g9x8dwcgeusdqhsplc0_20231220T160000Z"},"attendees":{"type":"array","description":"The attendees of the event.","items":{"type":"object","properties":{"booker":{"type":"boolean","description":"Whether the attendee is the booker.","readOnly":true,"example":true},"created":{"type":"string","description":"This field indicates when the attendee attended this event.","readOnly":true,"example":"2023-12-21T06:19:23.899Z"},"display_name":{"type":"string","description":"The attendee's name.","example":"bob"},"email":{"type":"string","description":"The attendee's email.","example":"abc@zoom.us"},"first_name":{"type":"string","description":"The attendee's first name.","example":"green"},"attendee_id":{"type":"string","description":"The ID of attendee.","readOnly":true,"example":"z7q0q2962w8iyj87249zbi7t10"},"last_name":{"type":"string","description":" The attendee's last name.","example":"tom"},"time_zone":{"type":"string","description":"The attendee's time zone.","example":"Asia/Shanghai"},"no_show":{"type":"boolean","description":"Whether to show events or not.","example":false},"customValues":{"type":"array","description":"The answers to the booking page questions.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the question.","example":"question1"},"position":{"type":"integer","description":"The position of the question.","example":1},"values":{"type":"array","description":"The answers to the question.","items":{"type":"string","description":"The answer to the question.","example":"At home"}}}}}},"description":"The attendee collection."}},"description":{"maxLength":8192,"type":"string","description":"The event's description.","example":"15 Minute Meeting"},"end_date_time":{"type":"string","description":"The scheduled event end date time.","example":"2023-12-21T16:30:00+08:00"},"guests":{"type":"array","description":"The guest's collection.","items":{"type":"string","description":"The guest's email.","example":"tom@zoom.us"}},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"start_date_time":{"type":"string","description":"The scheduled event start date time.","example":"2023-12-21T16:00:00+08:00"},"status":{"type":"string","description":"The status of event: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"updated":{"type":"string","description":"The moment the event was updated.","example":"2023-12-21T06:19:28.309Z"},"meeting_notes":{"maxLength":1024,"type":"string","description":"The meeting notes of the event.","example":"meeting notes"},"event_type":{"type":"string","description":"This field indicates the type is default(scheduled) or pending event.","readOnly":true,"example":"default","enum":["default","pending"]},"external_location":{"description":"The meeting details for when users have scheduled appointments.","readOnly":true,"oneOf":[{"type":"object","properties":{"kind":{"type":"string","description":"The type of meeting specified in the schedule.","example":"zoom"},"meeting_id":{"type":"string","description":"The unique identifier of the meeting in string format.","example":"94777886776"},"personal_meeting_id":{"type":"string","description":"The personal meeting id in string format.","example":"98656786887"},"meeting_passcode":{"type":"string","description":"The passcode of Zoom meeting.","example":"958000"},"meeting_description":{"type":"string","description":"The description of Zoom meeting.","example":"Invite you to meeting"},"meeting_join_url":{"type":"string","description":"The URL of Zoom meeting","example":"https://zoom.us/j/7427752805"}}}]},"tracking_params":{"type":"array","description":"The information to track the source of invitee. This occurs when you add UTM parameters in schedule links.","items":{"type":"object","properties":{"key":{"type":"string","description":"The UTM parameters in the schedule links.","example":"utm_source"},"label":{"type":"string","description":"The scheduler tags that correspond to UTM parameters one by one.","example":"UTM_Source"},"value":{"type":"string","description":"The value of UTM parameters set in schedule links by host.","example":"zoom"}}}}}}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:list_scheduled_events","scheduler:read:list_scheduled_events:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:list_scheduled_events","scheduler:read:list_scheduled_events:admin"]}}},"/scheduler/events/{eventId}":{"get":{"tags":["scheduled events"],"summary":"Get scheduled events ","description":"Returns a scheduled event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:scheduled_event`,`scheduler:read:scheduled_event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"get_scheduled_events","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"This field indicates whether the admin handles certain users. It's only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}},{"name":"team_id","in":"query","description":"The ID of the team to which the user belongs.","required":false,"schema":{"type":"string","example":"erayolgveb4bmtzn1ubx1lxe70"}}],"responses":{"200":{"description":"If successful, this method returns the scheduled event resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"event_id":{"type":"string","description":"The unique identifier of event.","example":"woft7torlatbw8ek24bmit5k60"},"schedule_id":{"type":"string","description":"The unique identifier of schedule.","example":"ygfx661g9x8dwcgeusdqhsplc0_20231220T160000Z"},"attendees":{"type":"array","description":"The attendees of the event.","items":{"type":"object","properties":{"booker":{"type":"boolean","description":"Whether the attendee is the booker.","readOnly":true,"example":true},"created":{"type":"string","description":"This field indicates when the attendee attended this event.","readOnly":true,"example":"2023-12-21T06:19:23.899Z"},"display_name":{"type":"string","description":"The attendee's name.","example":"bob"},"email":{"type":"string","description":"The attendee's email.","example":"abc@zoom.us"},"first_name":{"type":"string","description":"The attendee's first name.","example":"green"},"attendee_id":{"type":"string","description":"The ID of attendee.","readOnly":true,"example":"z7q0q2962w8iyj87249zbi7t10"},"last_name":{"type":"string","description":" The attendee's last name.","example":"tom"},"time_zone":{"type":"string","description":"The attendee's time zone.","example":"Asia/Shanghai"},"no_show":{"type":"boolean","description":"Whether or not to show the event.","example":false},"custom_values":{"type":"array","description":"The answers to the booking page questions.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the question.","example":"question1"},"position":{"type":"integer","description":"The position of the question.","example":1},"values":{"type":"array","description":"The answers to the question.","items":{"type":"string","description":"The answer to the question.","example":"At home"}}}}}}}},"description":{"maxLength":8192,"type":"string","description":"The event's description.","example":"15 Minute Meeting"},"end_date_time":{"type":"string","description":"The scheduled event's end date time.","example":"2023-12-21T16:30:00+08:00"},"guests":{"type":"array","description":"The guest's collection.","items":{"type":"string","description":"The guest's email.","example":"tom@zoom.us"}},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"start_date_time":{"type":"string","description":"The scheduled event's start date time.","example":"2023-12-21T16:00:00+08:00"},"status":{"type":"string","description":"The status of event: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"updated":{"type":"string","description":"The moment the event was updated.","example":"2023-12-21T06:19:28.309Z"},"meeting_notes":{"maxLength":1024,"type":"string","description":"The meeting notes of the event.","example":"meeting notes"},"event_type":{"type":"string","description":"This field indicates whether the type is default(scheduled) or a pending event.","readOnly":true,"example":"default","enum":["default","pending"]},"external_location":{"description":"The meeting details for when users have scheduled appointments.","readOnly":true,"oneOf":[{"type":"object","properties":{"kind":{"type":"string","description":"The type of meeting specified in the schedule.","example":"zoom"},"meeting_id":{"type":"string","description":"The unique identifier of the meeting in string format.","example":"94777886776"},"personal_meeting_id":{"type":"string","description":"The personal meeting id in string format.","example":"98656786887"},"meeting_passcode":{"type":"string","description":"The passcode of Zoom meeting.","example":"958000"},"meeting_description":{"type":"string","description":"The description of Zoom meeting.","example":"Invite you to meeting"},"meeting_join_url":{"type":"string","description":"The URL of Zoom meeting","example":"https://zoom.us/j/7427752805"}}}]},"tracking_params":{"type":"array","description":"The information to track the source of invitee. Only use this setting you add UTM parameters in schedule links.","items":{"type":"object","properties":{"key":{"type":"string","description":"The UTM parameters in schedule links.","example":"utm_source"},"label":{"type":"string","description":"The scheduler tags that correspond to UTM parameters one by one.","example":"UTM_Source"},"value":{"type":"string","description":"The value of UTM parameters set in schedule links by host.","example":"zoom"}}}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n NotFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:scheduled_event","scheduler:read:scheduled_event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:scheduled_event","scheduler:read:scheduled_event:admin"]}},"delete":{"tags":["scheduled events"],"summary":"Delete scheduled events ","description":"Deletes a scheduled event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:scheduled_event`,`scheduler:delete:scheduled_event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"delete_scheduled_events","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"query","description":"This field indicates whether the admin handles certain users. It's only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"responses":{"204":{"description":"If successful, this method returns an empty response body."},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n NotFound <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n Conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n IntenralErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:delete:scheduled_event","scheduler:delete:scheduled_event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:delete:scheduled_event","scheduler:delete:scheduled_event:admin"]}},"patch":{"tags":["scheduled events"],"summary":"Patch scheduled events","description":"Patches a scheduled event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:scheduled_event`,`scheduler:update:scheduled_event:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"patch_scheduled_events","parameters":[{"name":"eventId","in":"path","description":"The opaque identifier of the scheduled event.","required":true,"schema":{"type":"string","example":"yev6yf64xot16c0cco50f31tb0"}},{"name":"user_id","in":"query","description":"This field indicates whether the admin handles certain users. It's only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"requestBody":{"description":"In the request body, it supplies the relevant portions of event resource.","content":{"application/json":{"schema":{"type":"object","properties":{"attendees":{"type":"array","items":{"type":"object","properties":{"attendee_id":{"type":"string","description":"The ID of attendee.","readOnly":true,"example":"z7q0q2962w8iyj87249zbi7t10"},"no_show":{"type":"boolean","description":"This field inidcates the attendee if shown in the scheduled event","example":false},"email":{"type":"string","description":"The attendee's email.","example":"abc@zoom.us"}}}},"status":{"type":"string","description":"The status of event: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"meeting_notes":{"maxLength":1024,"type":"string","description":"The meeting notes of the event.","example":"meeting notes"}},"description":"The portions of the event resource."}}}},"responses":{"204":{"description":"If successful, this method returns an event resource in the response body."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n InvalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:update:scheduled_event","scheduler:update:scheduled_event:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:update:scheduled_event","scheduler:update:scheduled_event:admin"]}}},"/scheduler/events/{eventId}/attendees/{attendeeId}":{"get":{"tags":["scheduled events"],"summary":"Get scheduled event attendee","description":"Returns information about a specified attendee (person invited to an event).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:scheduled_event_attendee`,`scheduler:read:scheduled_event_attendee:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"get_scheduled_event_attendee","parameters":[{"name":"eventId","in":"path","description":"The ID of scheduled event.","required":true,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}},{"name":"attendeeId","in":"path","description":"The ID of attendee to get scheduled event attendee information.","required":true,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"responses":{"200":{"description":"If successful, this method returns the scheduled event attendee resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"attendee_id":{"type":"string","description":"The ID of attendee.","readOnly":true,"example":"z7q0q2962w8iyj87249zbi7t10"},"event_id":{"type":"string","description":"The unique identifier of event.","example":"woft7torlatbw8ek24bmit5k60"},"schedule_id":{"type":"string","description":"The unique identifier of schedule.","example":"woft7torlatbw8ek24bmit5k60"},"created":{"type":"string","description":"This field indicates when the attendee created this event.","readOnly":true,"example":"2023-12-21T06:19:23.899Z"},"display_name":{"type":"string","description":"The attendee's name.","example":"bob"},"email":{"type":"string","description":"The attendee's email.","example":"abc@zoom.us"},"first_name":{"type":"string","description":"The attendee's first name.","example":"green"},"last_name":{"type":"string","description":" The attendee's last name.","example":"tom"},"time_zone":{"type":"string","description":"The attendee's time zone.","example":"Asia/Shanghai"},"no_show":{"type":"boolean","description":"Whether an attendee did not attend an event.","example":false},"custom_values":{"maxItems":10,"type":"array","description":"The answer of the booking page questions.","items":{"type":"object","properties":{"name":{"maxLength":8192,"minLength":1,"type":"string","description":"The name of question.","example":"question1"},"position":{"maximum":9,"minimum":0,"type":"integer","description":"The position of question.","example":1},"values":{"maxItems":10,"type":"array","description":"The answers of question.","items":{"maxLength":1024,"minLength":1,"type":"string"}}}}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401 ` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n NotFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read","scheduler:read:admin","scheduler:read:scheduled_event_attendee","scheduler:read:scheduled_event_attendee:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read","scheduler:read:admin"],"x-granular-scopes":["scheduler:read:scheduled_event_attendee","scheduler:read:scheduled_event_attendee:admin"]}}},"/scheduler/schedules":{"get":{"tags":["schedules"],"summary":"List schedules","description":"Returns a list of all schedules.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:list_schedule`,`scheduler:read:list_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"list_schedules","parameters":[{"name":"to","in":"query","description":"The upper bound (exclusive) for a schedule's start time from which to filter.","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"from","in":"query","description":"The lower bound (exclusive) for a schedule's end time from which to filter.","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"page_size","in":"query","description":"The maximum number of schedule results returned on a result page.","required":false,"schema":{"type":"integer","example":250}},{"name":"next_page_token","in":"query","description":"The token that specifies which result page to return.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}},{"name":"show_deleted","in":"query","description":"Whether to include the deleted schedule (with status equals \"cancelled\") in the result.","required":false,"schema":{"type":"boolean","example":true}},{"name":"time_zone","in":"query","description":"The time zone in the response.","required":false,"schema":{"type":"string","example":"America/Los_Angeles"}},{"name":"user_id","in":"query","description":"The return of the specific user's schedules. Ths setting is only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl80"}},{"name":"team_id","in":"query","description":"The team ID to which the user belongs.","required":false,"schema":{"type":"string","example":"7aux3ldpd6jfwc7hsvtrcrz850"}},{"name":"search","in":"query","description":"This field returns search results from meeting ID or summary.","required":false,"schema":{"type":"string","example":"94777886776"}},{"name":"account_level","in":"query","description":"An optional field. The default is false. False means only list schedules of specify user, or it means list schedules of all users below current account.","required":false,"schema":{"type":"boolean","example":true}},{"name":"created_from","in":"query","description":"The lower bound (exclusive) for an event's create time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"created_to","in":"query","description":"The upper bound (exclusive) for an event's create time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"updated_from","in":"query","description":"The lower bound (exclusive) for an event's update time from which to filter.","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}},{"name":"updated_to","in":"query","description":"The upper bound (exclusive) for an event's update time from which to filter. ","required":false,"schema":{"type":"string","example":"2011-06-03T10:00:00-07:00"}}],"responses":{"200":{"description":"If successful, this method returns a response body with this structure.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The token that accesses the next page of this result.","example":"aec369a4fce6ae655749b00fc7260bfd"},"items":{"type":"array","items":{"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of the schedule.","example":"ygfx661g9x8dwcgeusdqhsplc0"},"add_on_type":{"type":"string","description":"The method of the type of `addOn`, such as Zoom meeting, Zoom phone, or offline.","example":"zoomMeeting","enum":["zoomMeeting","zoomPhone","offline"]},"availability_override":{"type":"boolean","description":"This field indicates the use of the availability rule.","example":false},"availability_rules":{"type":"array","description":"The availability of the time rule.","items":{"type":"object","properties":{"availability_id":{"type":"string","description":"The ID of this availability rule. ","example":"x3h1u4id4liffdyszsp8kpxl80"},"email":{"type":"string","description":"The owner of this availability rule. ","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sunday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"use_custom":{"type":"boolean","description":"This field indicates the use of custom availability instead of the rule.","example":false}}}},"booking_limit":{"maximum":96,"minimum":0,"type":"number","description":"This field sets the maximum events allowed per day.","example":0},"buffer":{"type":"object","properties":{"after":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time before the booked schedule.","example":0},"before":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time after the booked schedule.","example":0}},"description":"This field indicates the extra time before or after the booked schedule."},"capacity":{"maximum":200,"minimum":1,"type":"number","description":"This field indicates the maximum invitees per event.","example":1},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page.","example":"#fff200"},"creator":{"type":"object","properties":{"display_name":{"type":"string","description":"This field indicates the creator of the display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"This field indicates the creator's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if you created the schedule. The field is read-only.","readOnly":true,"example":true}},"description":"The creator of the schedule. This field is read-only."},"cushion":{"maximum":14340,"minimum":0,"type":"number","description":"This field indicates the minimum time before a schedule starts when the attendees can book.","example":0},"custom_fields":{"type":"array","description":"This field contains the custom question.","items":{"required":["enabled","format","include_other","name","position","required"],"type":"object","properties":{"custom_field_id":{"type":"string","description":"The ID of this question.","example":"0l6imf50il8jchyapni3p5ckc0"},"enabled":{"type":"boolean","description":"This field is true if the question the host creates is ON and visible on the event booking page. This field is false if it's OFF and invisible on the event booking page.","example":true},"format":{"type":"string","description":"The type of response that the invitee provides to the custom question. It can be one or multiple lines of text, a phone number, or single- or multiple-select.[`string text phone_number single_select multi_select`]","example":"text","enum":["text","string","phone_number","choices_one","choices_many","select"]},"include_other":{"type":"boolean","description":"This field is true if the custom question allows invitees to record a written response in addition to single-select or multiple-select type of responses. This field is false if the custom question does not allow invitees to record a written response.","example":false},"name":{"type":"string","description":"The custom question the host created for the event type.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"number","description":"The position of this question.","example":0},"required":{"type":"boolean","description":"This field is true if a response to the question created by the host is required for invitees to book the event type. This field is false if a response to the question created by the host is not required for invitees to book the event type.","example":false},"answer_choices":{"maxItems":50,"minItems":1,"type":"array","description":"The invitee's option(s) for single_select or multi_select type of responses.","items":{"maxLength":8192,"minLength":1,"type":"string","description":"The invitee's option for single_select or multi_select type of responses.","example":"At home"}}}}},"description":{"maxLength":8192,"type":"string","description":"The schedule's description.","example":"15 Minute Meeting"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"This field indicates the duration of the meeting in minutes, range: [1, 1440].","example":30},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-28"},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"organizer":{"type":"object","properties":{"display_name":{"type":"string","description":"The organizer's display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"The organizer's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if this user is the organizer. This field is read-only.","readOnly":true,"example":true}},"description":"The organizer of the schedule. This field is read-only."},"secret":{"type":"boolean","description":"This field indicates if the event type is hidden on the owner's main scheduling page.","example":false},"slug":{"maxLength":256,"minLength":3,"type":"string","description":"The event portion of the event's URL that identifies a specific web page.","example":"sales"},"scheduling_url":{"type":"string","description":"The URL of the user's scheduling site where invitees book this event type.","example":"https://scheduler.zoom.us/zoom_us/sales"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sunday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"the timezone of this availability rule. ","example":"Asia/Shanghai"},"start_time_increment":{"maximum":720,"minimum":5,"type":"number","description":"This field sets the frequency of available time slots for invitees.","example":30},"status":{"type":"string","description":"The status of schedule: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"schedule_type":{"type":"string","description":"This field indicates if the schedule type is \"one\" (belongs to an individual user) or \"multiple\".","example":"one","enum":["one","multiple"]},"updated":{"type":"string","description":"The moment the schedule type was updated.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"active":{"type":"boolean","description":"This field indicates if the schedule is active","example":true},"created":{"type":"string","description":"The moment the schedule type was created.","example":"2023-12-21T06:18:32.087Z"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n InvalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:list_schedule","scheduler:read:list_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:list_schedule","scheduler:read:list_schedule:admin"]}},"post":{"tags":["schedules"],"summary":"Insert schedules","description":"Creates a schedule.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:insert_schedule`,`scheduler:write:insert_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"insert_schedule","parameters":[{"name":"user_id","in":"query","description":"This field indicates that the admin handles certain users. This setting is only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"requestBody":{"description":"In the request body, it supplies the schedule resource properties.","content":{"application/json":{"schema":{"required":["availability_override","availability_rules","capacity","end","start","type"],"type":"object","properties":{"add_on_type":{"type":"string","description":"The method of the type of `addOn`, such as Zoom meeting, Zoom phone, or offline.","example":"zoomMeeting","enum":["zoomMeeting","zoomPhone","offline"]},"availability_override":{"type":"boolean","description":"This field indicates the use of the availability rule.","example":false},"availability_rules":{"type":"array","description":"The availability of the time rule.","items":{"type":"object","properties":{"availability_id":{"type":"string","description":"The ID of this availability rule. ","example":"x3h1u4id4liffdyszsp8kpxl80"},"email":{"type":"string","description":"The owner of this availability rule. ","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"the timezone of this availability rule. ","example":"Asia/Shanghai"},"use_custom":{"type":"boolean","description":"This field indicates the use of custom availability instead of the rule.","example":false}}}},"booking_limit":{"maximum":96,"minimum":0,"type":"number","description":"This field sets the maximum events allowed per day.","example":0},"buffer":{"type":"object","properties":{"after":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time before the booked schedule.","example":0},"before":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time after the booked schedule.","example":0}},"description":"This field indicates the extra time before or after the booked schedule."},"capacity":{"maximum":200,"minimum":1,"type":"number","description":"This field indicates the maximum invitees per event.","example":1},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page.","example":"#fff200"},"cushion":{"maximum":14340,"minimum":0,"type":"number","description":"This field indicates the minimum time before a schedule starts when the attendees can book.","example":0},"custom_fields":{"type":"array","description":"This field contains the custom question.","items":{"required":["enabled","format","include_other","name","position","required"],"type":"object","properties":{"custom_field_id":{"type":"string","description":"The ID of this question.","example":"0l6imf50il8jchyapni3p5ckc0"},"enabled":{"type":"boolean","description":"This field is true if the question the host creates is ON and visible on the event booking page. This field is false if it's OFF and invisible on the event booking page.","example":true},"format":{"type":"string","description":"The type of response that the invitee provides to the custom question. It can be one or multiple lines of text, a phone number, or single- or multiple-select.[`string text phone_number single_select multi_select`]","example":"text","enum":["text","string","phone_number","choices_one","choices_many","select"]},"include_other":{"type":"boolean","description":"This field is true if the custom question allows invitees to record a written response in addition to single-select or multiple-select type of responses. This field is false if the custom question does not allow invitees to record a written response.","example":false},"name":{"type":"string","description":"The custom question the host created for the event type.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"number","description":"The position of this question.","example":0},"required":{"type":"boolean","description":"This field is true if a response to the question created by the host is required for invitees to book the event type. This field is false if a response to the question created by the host is not required for invitees to book the event type.","example":false},"answer_choices":{"maxItems":50,"minItems":1,"type":"array","description":"The invitee's option(s) for `single_select` or `multi_select` type of responses.","items":{"maxLength":8192,"minLength":1,"type":"string","description":"The invitee's option for `single_select` or `multi_select` type of responses.","example":"At home"}}}}},"description":{"maxLength":8192,"type":"string","description":"The schedule's description.","example":"15 Minute Meeting"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"This field indicates the duration of the meeting in minutes, range: [1, 1440].","example":30},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-28"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"secret":{"type":"boolean","description":"This field indicates if the event type is hidden on the owner's main scheduling page.","example":false},"slug":{"maxLength":256,"minLength":3,"type":"string","description":"The event portion of the event's URL that identifies a specific web page.","example":"sales"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"start_time_increment":{"maximum":720,"minimum":5,"type":"number","description":"This field sets the frequency of available time slots for invitees.","example":30},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"schedule_type":{"type":"string","description":"This field indicates if the schedule type is \"one\" (belongs to an individual user) or \"multiple\".","example":"one","enum":["one","multiple"]},"active":{"type":"boolean","description":"This field indicates if the schedule is active.","example":true}}}}}},"responses":{"201":{"description":"If successful, this method returns an schedule resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of schedule.","example":"ygfx661g9x8dwcgeusdqhsplc0"},"add_on_type":{"type":"string","description":"The method of the type of `addOn`, such as Zoom meeting, Zoom phone, or offline.","example":"zoomMeeting","enum":["zoomMeeting","zoomPhone","offline"]},"availability_override":{"type":"boolean","description":"This field indicates the use of the availability rule.","example":false},"availability_rules":{"type":"array","description":"The availability of the time rule.","items":{"type":"object","properties":{"availability_id":{"type":"string","description":"The ID of this availability rule. ","example":"x3h1u4id4liffdyszsp8kpxl80"},"email":{"type":"string","description":"The owner of this availability rule. ","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"use_custom":{"type":"boolean","description":"This field indicates the use of custom availability instead of the rule.","example":false}}}},"booking_limit":{"maximum":96,"minimum":0,"type":"number","description":"This field sets the maximum events allowed per day.","example":0},"buffer":{"type":"object","properties":{"after":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time before the booked schedule.","example":0},"before":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time after the booked schedule.","example":0}},"description":"This field indicates the extra time before or after the booked schedule."},"capacity":{"maximum":200,"minimum":1,"type":"number","description":"This field indicates the maximum invitees per event.","example":1},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page.","example":"#fff200"},"creator":{"type":"object","properties":{"display_name":{"type":"string","description":"This field indicates the creator of the display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"This field indicates the creator's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if you created the schedule. The field is read-only.","readOnly":true,"example":true}},"description":"The creator of the schedule. The field is read-only."},"cushion":{"maximum":14340,"minimum":0,"type":"number","description":"This field indicates the minimum time before a schedule starts when the attendees can book.","example":0},"custom_fields":{"type":"array","description":"This field contains the custom question.","items":{"required":["enabled","format","include_other","name","position","required"],"type":"object","properties":{"custom_field_id":{"type":"string","description":"The ID of this question.","example":"0l6imf50il8jchyapni3p5ckc0"},"enabled":{"type":"boolean","description":"This field is true if the question the host creates is ON and visible on the event booking page. This field is false if it's OFF and invisible on the event booking page.","example":true},"format":{"type":"string","description":"The type of response that the invitee provides to the custom question. It can be one or multiple lines of text, a phone number, or single- or multiple-select.[`string text phone_number single_select multi_select`]","example":"text","enum":["text","string","phone_number","choices_one","choices_many","select"]},"include_other":{"type":"boolean","description":"This field is true if the custom question allows invitees to record a written response in addition to single-select or multiple-select type of responses. This field is false if the custom question does not allow invitees to record a written response.","example":false},"name":{"type":"string","description":"The custom question the host created for the event type.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"number","description":"The position of this question.","example":0},"required":{"type":"boolean","description":"This field is true if a response to the question created by the host is required for invitees to book the event type. This field is false if a response to the question created by the host is not required for invitees to book the event type.","example":false},"answer_choices":{"maxItems":50,"minItems":1,"type":"array","description":"The invitee's option(s) for single_select or multi_select type of responses.","items":{"maxLength":8192,"minLength":1,"type":"string","description":"The invitee's option for single_select or multi_select type of responses.","example":"At home"}}}}},"description":{"maxLength":8192,"type":"string","description":"The schedule's description.","example":"15 Minute Meeting"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"This field indicates the duration of the meeting in minutes, range: [1, 1440].","example":30},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-20"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"the timezone of this availability rule. ","example":"Asia/Shanghai"},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"organizer":{"type":"object","properties":{"display_name":{"type":"string","description":"The organizer's display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"The organizer's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if this user is the organizer. This field is read-only.","readOnly":true,"example":true}},"description":"The organizer of the schedule. This field is read-only."},"secret":{"type":"boolean","description":"This field indicates if the event type is hidden on the owner's main scheduling page.","example":false},"slug":{"maxLength":256,"minLength":3,"type":"string","description":"The event portion of the event's URL that identifies a specific web page.","example":"sales"},"scheduling_url":{"type":"string","description":"The URL of the user’s scheduling site where invitees book this event type.","example":"https://scheduler.zoom.us/zoom_us/sales"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"start_time_increment":{"maximum":720,"minimum":5,"type":"number","description":"This field sets the frequency of available time slots for invitees.","example":30},"status":{"type":"string","description":"The status of schedule: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"schedule_type":{"type":"string","description":"This field indicates if the schedule type is \"one\" (belongs to an individual user) or \"multiple\".","example":"one","enum":["one","multiple"]},"updated":{"type":"string","description":"The moment the schedule type was updated.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"active":{"type":"boolean","description":"This field indicates if the schedule is active.","example":true}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n InvalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:write:insert_schedule","scheduler:write:insert_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:write:insert_schedule","scheduler:write:insert_schedule:admin"]}}},"/scheduler/schedules/{scheduleId}":{"get":{"tags":["schedules"],"summary":"Get schedules","description":"Returns a schedule.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"get_schedule","parameters":[{"name":"scheduleId","in":"path","description":"The schedule's unique identifier.","required":true,"schema":{"type":"string","example":"aec369a4fce6ae655749b00fc7260bfd"}},{"name":"user_id","in":"query","description":"This field indicates that admins handle certain users. This setting is only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"responses":{"200":{"description":"If successful, this method returns an schedule resource in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of a schedule.","example":"ygfx661g9x8dwcgeusdqhsplc0"},"add_on_type":{"type":"string","description":"The method of the type of `addOn`, such as Zoom meeting, Zoom phone, or offline.","example":"zoomMeeting","enum":["zoomMeeting","zoomPhone","offline"]},"availability_override":{"type":"boolean","description":"This field indicates the use of the availability rule.","example":false},"availability_rules":{"type":"array","description":"The availability of the time rule.","items":{"type":"object","properties":{"availability_id":{"type":"string","description":"The ID of this availability rule. ","example":"x3h1u4id4liffdyszsp8kpxl80"},"email":{"type":"string","description":"The owner of this availability rule. ","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of available time rule."},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"use_custom":{"type":"boolean","description":"This field indicates the use of custom availability instead of the rule.","example":false}}}},"booking_limit":{"maximum":96,"minimum":0,"type":"number","description":"This field sets the maximum events allowed per day.","example":0},"buffer":{"type":"object","properties":{"after":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time before the booked schedule.","example":0},"before":{"maximum":240,"minimum":0,"type":"number","description":"This field adds the time after the booked schedule.","example":0}},"description":"This field indicates the extra time before or after the booked schedule."},"capacity":{"maximum":200,"minimum":1,"type":"number","description":"This field indicates the maximum invitees per event.","example":1},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page.","example":"#fff200"},"creator":{"type":"object","properties":{"display_name":{"type":"string","description":"This field indicates the creator of the display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"This field indicates the creator's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if you created the schedule. The field is read-only.","readOnly":true,"example":true}},"description":"The creator of the schedule. The field is read-only."},"cushion":{"maximum":14340,"minimum":0,"type":"number","description":"This field indicates the minimum time before a schedule starts when the attendees can book.","example":0},"custom_fields":{"type":"array","description":"This field contains the custom question.","items":{"required":["enabled","format","include_other","name","position","required"],"type":"object","properties":{"custom_field_id":{"type":"string","description":"The ID of this question.","example":"0l6imf50il8jchyapni3p5ckc0"},"enabled":{"type":"boolean","description":"This field is true if the question the host creates is ON and visible on the event booking page. This field is false if it's OFF and invisible on the event booking page.","example":true},"format":{"type":"string","description":"The type of response that the invitee provides to the custom question. It can be one or multiple lines of text, a phone number, or single- or multiple-select.[`string text phone_number single_select multi_select`]","example":"text","enum":["text","string","phone_number","choices_one","choices_many","select"]},"include_other":{"type":"boolean","description":"This field is true if the custom question allows invitees to record a written response in addition to single-select or multiple-select type of responses. This field is false if the custom question does not allow invitees to record a written response.","example":false},"name":{"type":"string","description":"The custom question the host created for the event type.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"number","description":"The position of this question.","example":0},"required":{"type":"boolean","description":"This field is true if a response to the question created by the host is required for invitees to book the event type. This field is false if a response to the question created by the host is not required for invitees to book the event type.","example":false},"answer_choices":{"maxItems":50,"minItems":1,"type":"array","description":"The invitee's option(s) for single_select or multi_select type of responses.","items":{"maxLength":8192,"minLength":1,"type":"string","description":"The invitee's option for single_select or multi_select type of responses.","example":"At home"}}}}},"description":{"maxLength":8192,"type":"string","description":"The schedule's description.","example":"15 Minute Meeting"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"This field indicates the duration of the meeting in minutes, range: [1, 1440].","example":30},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-28"},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"organizer":{"type":"object","properties":{"display_name":{"type":"string","description":"The organizer's display name.","readOnly":true,"example":"name"},"email":{"type":"string","description":"The organizer's email address.","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"self":{"type":"boolean","description":"This field indicates if this user is the organizer. This field is read-only.","readOnly":true,"example":true}},"description":"The organizer of the schedule. This field is read-only."},"secret":{"type":"boolean","description":"This field indicates if the event type is hidden on the owner's main scheduling page.","example":false},"slug":{"maxLength":256,"minLength":3,"type":"string","description":"The event portion of the event's URL that identifies a specific web page.","example":"sales"},"scheduling_url":{"type":"string","description":"The URL of the user's scheduling site where invitees book this event type.","example":"https://scheduler.zoom.us/zoom_us/sales"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"the timezone of this availability rule. ","example":"Asia/Shanghai"},"start_time_increment":{"maximum":720,"minimum":5,"type":"number","description":"This field sets the frequency of available time slots for invitees.","example":30},"status":{"type":"string","description":"The status of schedule: confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"schedule_type":{"type":"string","description":"This field indicates if the schedule type is **one** (belongs to an individual user) or **multiple**.","example":"one","enum":["one","multiple"]},"updated":{"type":"string","description":"The moment the schedule type was updated.","readOnly":true,"example":"2023-12-21T06:18:32.087Z"},"active":{"type":"boolean","description":"This field indicates if the schedule is active.","example":true}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n NotFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:get_schedule","scheduler:read:get_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:get_schedule","scheduler:read:get_schedule:admin"]}},"delete":{"tags":["schedules"],"summary":"Delete schedules","description":"Deletes a schedule.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:delete:delete_schedule`,`scheduler:delete:delete_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"delete_schedules","parameters":[{"name":"scheduleId","in":"path","description":"The unique identifier of the schedule.","required":true,"schema":{"type":"string","example":"aec369a4fce6ae655749b00fc7260bfd"}},{"name":"user_id","in":"query","description":"This field indicates that the admin handles certain users. This setting is only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"responses":{"204":{"description":"If successful, this method returns an empty response body."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401 ` <br>\n unauthorized <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:delete:delete_schedule","scheduler:delete:delete_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:delete:delete_schedule","scheduler:delete:delete_schedule:admin"]}},"patch":{"tags":["schedules"],"summary":"Patch schedules","description":"Patches a schedule. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:update:patch_schedule`,`scheduler:update:patch_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"patch_schedule","parameters":[{"name":"scheduleId","in":"path","description":"The schedule's unique identifier.","required":true,"schema":{"type":"string","example":"aec369a4fce6ae655749b00fc7260bfd"}},{"name":"user_id","in":"query","description":"This field indicates that the admin handles certain users. This setting is only for admin.","required":false,"schema":{"type":"string","example":"x3h1u4id4liffdyszsp8kpxl8"}}],"requestBody":{"description":"In the request body, it supplies the relevant portions of a schedule resource, according to the rules of patch semantics.","content":{"application/json":{"schema":{"type":"object","properties":{"add_on_type":{"type":"string","description":"The method of `addOn`, such as Zoom meeting, Zoom phone, and offline.","example":"zoomMeeting","enum":["zoomMeeting","zoomPhone","offline"]},"availability_override":{"type":"boolean","description":"This field indicates the use of the availability rule.","example":false},"availability_rules":{"type":"array","description":"The availability time rule.","items":{"type":"object","properties":{"email":{"type":"string","description":"The owner of this availability rule. ","example":"easonfsxsysks3lgchitiw@scheduler.zoom.us"},"availability_id":{"type":"string","description":"The ID of this availability rule. ","example":"x3h1u4id4liffdyszsp8kpxl80"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date-time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date-time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sunday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of available time rule."},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"use_custom":{"type":"boolean","description":"This field indicates whether to use the custom availability instead of the rule.","example":false}}}},"booking_limit":{"maximum":96,"minimum":0,"type":"number","description":"This field sets the maximum events allowed per day.","example":0},"buffer":{"type":"object","properties":{"after":{"maximum":240,"minimum":0,"type":"number","description":"This field adds time before the booked schedule.","example":0},"before":{"maximum":240,"minimum":0,"type":"number","description":"This field adds time after the booked schedule.","example":0}},"description":"The extra time before or after booked schedule."},"capacity":{"maximum":200,"minimum":1,"type":"number","description":"The maximum invitees per event.","example":1},"color":{"type":"string","description":"The hexadecimal color value of the event type's scheduling page.","example":"#fff200"},"cushion":{"maximum":14340,"minimum":0,"type":"number","description":"The minimum time before a schedule starts that attendees can book.","example":0},"custom_fields":{"type":"array","description":"The custom question.","items":{"required":["enabled","format","include_other","name","position","required"],"type":"object","properties":{"enabled":{"type":"boolean","description":"If the question created by the host is turned ON and visible on the event booking page, then it's true. If it's turned OFF and invisible on the event booking page, then it's false.","example":true},"format":{"type":"string","description":"The type of response that the invitee provides to the custom question. It can be one or multiple lines of text, a phone number, or single- or multiple-select.[`string text phone_number single_select multi_select`]","example":"text","enum":["text","string","phone_number","choices_one","choices_many","select"]},"custom_field_id":{"type":"string","description":"The ID of this question","example":"0l6imf50il8jchyapni3p5ckc0"},"include_other":{"type":"boolean","description":"If the custom question lets invitees record a written response, in addition to single-select or multiple-select type of responses, then it's true. Otherwise, it's false.","example":false},"name":{"type":"string","description":"The custom question that the host created for the event type.","example":"Please share anything that will help prepare for our meeting."},"position":{"type":"number","description":"The position of this question.","example":0},"required":{"type":"boolean","description":"If a response to the question, created by the host, is required for invitees to book the event type, then it's true. If it's not required, it's false.","example":false},"answer_choices":{"maxItems":50,"minItems":1,"type":"array","description":"The invitee's option(s) for single_select or multi_select type of responses.","items":{"maxLength":8192,"minLength":1,"type":"string","description":"The invitee's option for single_select or multi_select type of responses.","example":"At home"}}}}},"description":{"maxLength":8192,"type":"string","description":"The schedule's description","example":"15 Minute Meeting"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"The duration of meeting in minutes, range: [1, 1440].","example":30},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-28"},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sunday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"time_zone":{"type":"string","description":"the timezone of this availability rule. ","example":"Asia/Shanghai"},"location":{"maxLength":1024,"type":"string","description":"The information for a custom location.","example":"AAA office"},"secret":{"type":"boolean","description":"This field indicates if the event type is hidden on the owner's main scheduling page.","example":false},"slug":{"maxLength":256,"minLength":3,"type":"string","description":"The event portion of the event's URL that identifies a specific web page.","example":"sales"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"start_time_increment":{"maximum":720,"minimum":5,"type":"number","description":"This field sets the frequency of available time slots for invitees.","example":30},"status":{"type":"string","description":"The status of schedule, confirmed or cancelled.","example":"confirmed","enum":["confirmed","cancelled"]},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"summary":{"maxLength":256,"type":"string","description":"The event's summary.","example":"daily meeting"},"active":{"type":"boolean","description":"This field indicates if the schedule is active.","example":true}}}}}},"responses":{"204":{"description":"If successful, this method returns an empty response body."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n InvaildArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n NotFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InternalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:update:patch_schedule","scheduler:update:patch_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:update:patch_schedule","scheduler:update:patch_schedule:admin"]}}},"/scheduler/schedules/{scheduleId}/available_times":{"get":{"tags":["schedules"],"summary":"List schedule available times","description":"Returns available time slots for a given schedule, including day-level and spot-level availability, custom fields, recurrence rules, and scheduling segments. Use this to find bookable time slots before creating a scheduled event.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"list_available_time","parameters":[{"name":"scheduleId","in":"path","description":"The unique identifier of the schedule or scheduling page this query belongs to.","required":true,"schema":{"type":"string","example":"s4xg14dfoxu4t7avyd8453vr90"}},{"name":"from","in":"query","description":"The minimum time boundary (start time) for querying available slots. Must be in ISO 8601 / RFC 3339 format in UTC.","required":true,"schema":{"type":"string","format":"date-time","example":"2026-03-23T00:00:00Z"}},{"name":"to","in":"query","description":"The maximum time boundary (end time) for querying available slots. Must be in ISO 8601 / RFC 3339 format in UTC. Must be strictly after `from`.","required":true,"schema":{"type":"string","format":"date-time","example":"2026-04-03T23:59:59Z"}},{"name":"user","in":"query","description":"The user slug identifier to filter available time slots for a specific host or team member. Format: `t/` followed by the user identifier, for example `t/x0ghart`. Required if the schedule object contains a `user` field — pass the exact value from that field. Omit if the schedule has no `user` field.","required":false,"schema":{"type":"string","example":"t/x0ghart"}},{"name":"time_zone","in":"query","description":"The timezone identifier of the user or location, represented in the IANA Time Zone Database format (e.g., \"America/Los_Angeles\").","required":false,"schema":{"type":"string","example":"America/Los_Angeles"}}],"responses":{"200":{"description":"Successfully returned the available time slots.","content":{"application/json":{"schema":{"required":["days","duration","schedule_id"],"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of the schedule. Matches the `schedule_id` in the request path.","example":"ppusajjudy3zniqtmpwm3corc0"},"duration":{"type":"integer","description":"The duration of each bookable time slot in minutes. For example, `30` means each slot is a 30-minute meeting. The end time of a slot equals `start_time` plus `duration`.","example":30},"days":{"type":"array","description":"List of days within the queried time range. Each day contains its overall availability status and individual time spots. This is the primary data to use when presenting available slots to the user.","items":{"type":"object","properties":{"date":{"type":"string","description":"The date in `YYYY-MM-DD` format.","format":"date","example":"2026-03-25"},"status":{"type":"string","description":"Day-level availability summary. `available` means at least one spot on this day is bookable. `unavailable` means all spots on this day are taken or blocked — skip this day entirely when presenting options.","example":"available","enum":["available","unavailable"]},"spots":{"type":"array","description":"List of individual time slots within this day. Each spot represents one bookable unit of `duration` minutes. Only spots with status `available` can be booked.","items":{"type":"object","properties":{"start_time":{"type":"string","description":"The start time of this slot in ISO 8601 format with the host's timezone offset (for example, `-07:00` for `America/Los_Angeles`). The meeting would run from `start_time` to `start_time` plus `duration` minutes.","format":"date-time","example":"2026-03-25T09:00:00Z"},"status":{"type":"string","description":"Slot-level availability. `available` means this specific time slot is open and bookable. `unavailable` means this slot is already taken, blocked, or outside working hours.","example":"available","enum":["available","unavailable"]},"available_number":{"type":"integer","description":"The number of remaining bookable seats for this slot. Typically `1` for one-on-one schedules. Can be greater than `1` for group events.","example":1}}}}}}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unregistered user or expired token.\n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  The schedule does not exist.\n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  A service error occurred.\n\n "},"502":{"description":"**HTTP Status Code:** `502` <br>\n Bad Gateway  A service routing error occurred.\n\n "}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:get_schedule","scheduler:read:get_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:get_schedule","scheduler:read:get_schedule:admin"]}}},"/scheduler/schedules/single_use_link":{"post":{"tags":["scheduling links"],"summary":"Single use link","description":"Creates a single-use scheduling link.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:admin`,`scheduler:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:single_use_link`,`scheduler:write:single_use_link:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"single_use_link","parameters":[{"name":"team_id","in":"query","description":"This field identifies the specific team. If this parameter exists, the link will be created for the team to which the user belongs.","required":false,"schema":{"type":"string","example":"aux3ldpd6jfwc7hsvtrcrz850"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["schedule_id"],"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of a schedule.","example":"kb1i8qrplqn7r3zmmhphz4uxd0"}}}}}},"responses":{"201":{"description":"If successful, this method returns a scheduling link URL in the response body.","content":{"application/json":{"schema":{"required":["scheduling_url"],"type":"object","properties":{"scheduling_url":{"type":"string","description":"The scheduling link URL.","example":"https://scheduler.zoomdev.us/manage/xu3o9skk6ygg8gk5hjvokjm2c0"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `409` <br>\n conflict <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write:admin","scheduler:write","scheduler:write:single_use_link","scheduler:write:single_use_link:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write:admin","scheduler:write"],"x-granular-scopes":["scheduler:write:single_use_link","scheduler:write:single_use_link:admin"]}}},"/scheduler/shares":{"post":{"tags":["shares"],"summary":"Create shares","description":"Creates an endpoint for our Customize Once and Share feature. This API allows you to customize schedule for a specific attendee without needing to make an entirely new schedules.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write`,`scheduler:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:write:share`,`scheduler:write:share:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"create_shares","requestBody":{"content":{"application/json":{"schema":{"required":["schedule_id"],"type":"object","properties":{"schedule_id":{"type":"string","description":"The unique identifier of a schedule.","example":"kb1i8qrplqn7r3zmmhphz4uxd0"},"start_date":{"type":"string","description":"The schedule's start date.","example":"2023-12-21"},"end_date":{"type":"string","description":"The schedule's end date.","example":"2023-12-20"},"interval_type":{"type":"string","description":"The schedule time range. Unlimited means forever and fixed means using `startDate` and `endDate`.","example":"fixed","enum":["unlimited","fixed"]},"time_zone":{"type":"string","description":"The timezone of this availability rule. ","example":"Asia/Shanghai"},"duration":{"maximum":1440,"minimum":15,"type":"number","description":"This field indicates the duration of the meeting in minutes, range: [1, 1440].","example":30},"segments_recurrence":{"type":"object","properties":{"sun":{"type":"array","description":"Sundays","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"mon":{"type":"array","description":"Monday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"tue":{"type":"array","description":"Tuesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"wed":{"type":"array","description":"Wednesday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"thu":{"type":"array","description":"Thursday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"fri":{"type":"array","description":"Friday ","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}},"sat":{"type":"array","description":"Saturday","items":{"type":"object","properties":{"end":{"type":"string","description":"The end time of this day.","example":"17:00"},"start":{"type":"string","description":"The start time of this day.","example":"09:00"}}}}},"description":"The week of the available time rule."},"segments":{"type":"array","description":"The available time segments of the event.","items":{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the segment.","example":"2023-12-21T06:00:00Z"},"end":{"type":"string","description":"The end date and time of the segment.","example":"2023-12-21T06:00:00Z"}}}}}}}}},"responses":{"201":{"description":"Returned a customed link ","content":{"application/json":{"schema":{"required":["scheduling_url"],"type":"object","properties":{"scheduling_url":{"type":"string","description":"The scheduling link URL.","example":"https://scheduler.zoom.us/t/tc71av50/one-one-host"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n InvaildArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n Unauthorized  <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n InrernalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:write","scheduler:write:admin","scheduler:write:share","scheduler:write:share:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:write","scheduler:write:admin"],"x-granular-scopes":["scheduler:write:share","scheduler:write:share:admin"]}}},"/scheduler/teams":{"get":{"tags":["team"],"summary":"List team","description":"Lists teams for the specified user, or for the current user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read`,`scheduler:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:get_schedule`,`scheduler:read:get_schedule:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Listteam","parameters":[{"name":"user_id","in":"query","description":"This field specifies teams that include a specific user","required":false,"schema":{"type":"string","example":"Hrk8hOM-TpaY9t4zlLf-Cg"}}],"responses":{"200":{"description":"The response body of the list team.","content":{"application/json":{"schema":{"type":"object","properties":{"teams":{"maxItems":1000,"type":"array","description":"A collection of all existing team items.","items":{"type":"object","properties":{"team_id":{"type":"string","description":"The team ID.","example":"ewayolgveb4bmtzn1ubx1lxe71"},"owner_id":{"type":"string","description":"The owner user ID of the team.","example":"pE96RQ1nSbaboXClJS2Gfw"},"member_count":{"type":"integer","description":"The team members count between 0 and 10000.","example":500},"name":{"type":"string","description":"The name of the team.","example":"test team"},"slug":{"type":"string","description":"The slug of the team.","example":"walmart-vok"},"timezone":{"type":"string","description":"The timezone of the team.","example":"Asia/Shanghai"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  The query URL is invalid \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  The query user is unauthroized \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server is temporarily unavailable \n\n "}},"security":[{"openapi_oauth":["scheduler:read","scheduler:read:admin","scheduler:read:get_schedule","scheduler:read:get_schedule:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read","scheduler:read:admin"],"x-granular-scopes":["scheduler:read:get_schedule","scheduler:read:get_schedule:admin"]}}},"/scheduler/users/{userId}":{"get":{"tags":["users"],"summary":"Get user","description":"Returns information about the user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:admin`,`scheduler:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `scheduler:read:user`,`scheduler:read:user:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"get_user","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"If successful, this method returns user information in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"The portion of URL for the user's scheduling page where invitees book sessions that renders in a human-readable format.","example":"zoom_us"},"scheduling_url":{"type":"string","description":"The URL of the user’s scheduling site where invitees book this event type.","example":"https://scheduler.zoom.us/zoom_us"},"display_name":{"type":"string","description":"The user's name","example":"name"},"picture":{"type":"string","description":"This field enables users to upload their personal avatars on Zoom.","example":"base64 encoding string"},"logo":{"type":"string","description":"This field enables users to upload their company's logo on Zoom.","example":"user logo"},"time_zone":{"type":"string","description":"The time zone to use when presenting time to the user.","example":"America/New York"}},"description":"The user's information."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n invalidArgument <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `401` <br>\n unauthorized <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n notFound <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n **Error Code:** `500` <br>\n internalErr <br>\n"}},"security":[{"openapi_oauth":["scheduler:read:admin","scheduler:read","scheduler:read:user","scheduler:read:user:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["scheduler:read:admin","scheduler:read"],"x-granular-scopes":["scheduler:read:user","scheduler:read:user:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"scheduler:read":"scheduler:read","scheduler:read:admin":"scheduler:read:admin","scheduler:read:routing":"scheduler:read:routing","scheduler:read:routing:admin":"scheduler:read:routing:admin","scheduler:read:analytics":"scheduler:read:analytics","scheduler:read:analytics:admin":"scheduler:read:analytics:admin","scheduler:read:list_availability":"scheduler:read:list_availability","scheduler:read:list_availability:admin":"scheduler:read:list_availability:admin","scheduler:write:admin":"scheduler:write:admin","scheduler:write":"scheduler:write","scheduler:write:availability":"scheduler:write:availability","scheduler:write:availability:admin":"scheduler:write:availability:admin","scheduler:read:availability":"scheduler:read:availability","scheduler:read:availability:admin":"scheduler:read:availability:admin","scheduler:update:availability":"scheduler:update:availability","scheduler:update:availability:admin":"scheduler:update:availability:admin","scheduler:delete:availability":"scheduler:delete:availability","scheduler:delete:availability:admin":"scheduler:delete:availability:admin","scheduler:write:scheduled_event":"scheduler:write:scheduled_event","scheduler:write:scheduled_event:admin":"scheduler:write:scheduled_event:admin","scheduler:read:list_scheduled_events":"scheduler:read:list_scheduled_events","scheduler:read:list_scheduled_events:admin":"scheduler:read:list_scheduled_events:admin","scheduler:read:scheduled_event":"scheduler:read:scheduled_event","scheduler:read:scheduled_event:admin":"scheduler:read:scheduled_event:admin","scheduler:delete:scheduled_event":"scheduler:delete:scheduled_event","scheduler:delete:scheduled_event:admin":"scheduler:delete:scheduled_event:admin","scheduler:update:scheduled_event":"scheduler:update:scheduled_event","scheduler:update:scheduled_event:admin":"scheduler:update:scheduled_event:admin","scheduler:read:scheduled_event_attendee":"scheduler:read:scheduled_event_attendee","scheduler:read:scheduled_event_attendee:admin":"scheduler:read:scheduled_event_attendee:admin","scheduler:read:list_schedule":"scheduler:read:list_schedule","scheduler:read:list_schedule:admin":"scheduler:read:list_schedule:admin","scheduler:write:insert_schedule":"scheduler:write:insert_schedule","scheduler:write:insert_schedule:admin":"scheduler:write:insert_schedule:admin","scheduler:update:patch_schedule":"scheduler:update:patch_schedule","scheduler:update:patch_schedule:admin":"scheduler:update:patch_schedule:admin","scheduler:read:get_schedule":"scheduler:read:get_schedule","scheduler:read:get_schedule:admin":"scheduler:read:get_schedule:admin","scheduler:delete:delete_schedule":"scheduler:delete:delete_schedule","scheduler:delete:delete_schedule:admin":"scheduler:delete:delete_schedule:admin","scheduler:write:single_use_link":"scheduler:write:single_use_link","scheduler:write:single_use_link:admin":"scheduler:write:single_use_link:admin","scheduler:write:share":"scheduler:write:share","scheduler:write:share:admin":"scheduler:write:share:admin","scheduler:read:user":"scheduler:read:user","scheduler:read:user:admin":"scheduler:read:user:admin"}}}}}}}