@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Zoom API
@base https://api.zoom.us/v2
@version 2.0.0
@auth ApiKey access_token in query
@endpoints 155
@hint download_for_search
@toc accounts(15), groups(8), h323(4), tracking_fields(5), im(10), users(35), meetings(22), past_meetings(3), metrics(16), report(12), tsp(2), webinars(16), past_webinars(1), webhooks(6)

@group accounts
@endpoint GET /accounts
@optional {page_size: any, page_number: any}
@returns(200)

@endpoint POST /accounts
@required {body: map}
@returns(201)
@errors {409}

@endpoint GET /accounts/{accountId}
@required {accountId: any}
@returns(200)
@errors {404}

@endpoint DELETE /accounts/{accountId}
@required {accountId: any}
@returns(204)
@errors {404}

@endpoint PATCH /accounts/{accountId}/options
@required {accountId: any, body: map}
@returns(204)
@errors {404}

@endpoint GET /accounts/{accountId}/settings
@required {accountId: any}
@returns(200)
@errors {404}

@endpoint PATCH /accounts/{accountId}/settings
@required {accountId: any, body: map}
@returns(204)
@errors {404}

@endpoint GET /accounts/{accountId}/managed_domains
@required {accountId: any}
@returns(200)
@errors {404}

@endpoint GET /accounts/{accountId}/billing
@required {accountId: any}
@returns(200)
@errors {404}

@endpoint PATCH /accounts/{accountId}/billing
@required {accountId: any, body: map}
@returns(204)
@errors {404}

@endpoint GET /accounts/{accountId}/plans
@required {accountId: any}
@returns(200)
@errors {404}

@endpoint POST /accounts/{accountId}/plans
@required {accountId: any, body: any}
@returns(201)

@endpoint PUT /accounts/{accountId}/plans/base
@required {accountId: any, body: map}
@returns(204)

@endpoint POST /accounts/{accountId}/plans/addons
@required {accountId: any, body: map}
@returns(201)

@endpoint PUT /accounts/{accountId}/plans/addons
@required {accountId: any, body: map}
@returns(204)

@endgroup

@group groups
@endpoint GET /groups
@returns(200)

@endpoint POST /groups
@required {body: any}
@returns(201)

@endpoint GET /groups/{groupId}
@required {groupId: any}
@returns(200)
@errors {404}

@endpoint PATCH /groups/{groupId}
@required {groupId: any, body: any}
@returns(204)
@errors {404}

@endpoint DELETE /groups/{groupId}
@required {groupId: any}
@returns(204)
@errors {404}

@endpoint GET /groups/{groupId}/members
@required {groupId: any}
@optional {page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /groups/{groupId}/members
@required {groupId: any, body: any}
@returns(201)
@errors {404}

@endpoint DELETE /groups/{groupId}/members/{memberId}
@required {groupId: any, memberId: any}
@returns(204)
@errors {404}

@endgroup

@group h323
@endpoint GET /h323/devices
@returns(200)

@endpoint POST /h323/devices
@required {body: map}
@returns(201)

@endpoint PATCH /h323/devices/{deviceId}
@required {deviceId: any, body: map}
@returns(204)
@errors {404}

@endpoint DELETE /h323/devices/{deviceId}
@required {deviceId: any}
@returns(204)
@errors {404}

@endgroup

@group tracking_fields
@endpoint GET /v2/tracking_fields
@returns(200)

@endpoint POST /v2/tracking_fields
@required {body: map}
@returns(201)

@endpoint GET /v2/tracking_fields/{fieldId}
@required {fieldId: any}
@returns(200)
@errors {404}

@endpoint PATCH /v2/tracking_fields/{fieldId}
@required {fieldId: any, body: map}
@returns(204)
@errors {404}

@endpoint DELETE /v2/tracking_fields/{fieldId}
@required {fieldId: any}
@returns(204)
@errors {404}

@endgroup

@group im
@endpoint GET /im/groups
@returns(200)

@endpoint POST /im/groups
@required {body: any}
@returns(201)

@endpoint GET /im/groups/{groupId}
@required {groupId: any}
@returns(200)
@errors {404}

@endpoint PATCH /im/groups/{groupId}
@required {groupId: any, body: any}
@returns(204)
@errors {404}

@endpoint DELETE /im/groups/{groupId}
@required {groupId: any}
@returns(204)
@errors {404}

@endpoint GET /im/groups/{groupId}/members
@required {groupId: any}
@optional {page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /im/groups/{groupId}/members
@required {groupId: any, body: any}
@returns(201)
@errors {404}

@endpoint DELETE /im/groups/{groupId}/members/{memberId}
@required {groupId: any, memberId: any}
@returns(204)
@errors {404}

@endpoint GET /im/chat/sessions
@required {from: any, to: any}
@optional {page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /im/chat/sessions/{sessionId}
@required {sessionId: any, from: any, to: any}
@optional {page_size: any, next_page_token: any}
@returns(200)

@endgroup

@group users
@endpoint GET /users/{userId}/meetings
@required {userId: any}
@optional {type: any, page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /users/{userId}/meetings
@required {userId: any, body: any}
@returns(201)
@errors {404}

@endgroup

@group meetings
@endpoint GET /meetings/{meetingId}
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint PATCH /meetings/{meetingId}
@required {meetingId: any, body: any}
@returns(204)
@errors {404}

@endpoint DELETE /meetings/{meetingId}
@required {meetingId: any}
@optional {occurrence_id: any}
@returns(204)
@errors {404}

@endpoint PUT /meetings/{meetingId}/status
@required {meetingId: any, body: any}
@returns(204)
@errors {404}

@endpoint GET /meetings/{meetingId}/invitation
@required {meetingId: any}
@returns(200)

@endpoint GET /meetings/{meetingId}/registrants
@required {meetingId: any}
@optional {occurrence_id: any, status: any, page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /meetings/{meetingId}/registrants
@required {meetingId: any, body: map}
@optional {occurrence_ids: any}
@returns(201)
@errors {404}

@endpoint PUT /meetings/{meetingId}/registrants/status
@required {meetingId: any, body: map}
@optional {occurrence_id: any}
@returns(204)
@errors {404}

@endpoint PATCH /meetings/{meetingId}/livestream
@required {meetingId: any, body: map}
@returns(204)
@errors {404}

@endpoint PATCH /meetings/{meetingId}/livestream/status
@required {meetingId: any, body: map}
@returns(204)
@errors {404}

@endgroup

@group past_meetings
@endpoint GET /past_meetings/{meetingUUID}
@required {meetingUUID: any}
@returns(200)
@errors {404}

@endpoint GET /past_meetings/{meetingUUID}/participants
@required {meetingUUID: any}
@optional {page_size: any, next_page_token: any}
@returns(200)
@errors {404}

@endpoint GET /past_meetings/{meetingId}/instances
@required {meetingId: any}
@returns(200)
@errors {404}

@endgroup

@group meetings
@endpoint GET /meetings/{meetingId}/polls
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint POST /meetings/{meetingId}/polls
@required {meetingId: any, body: any}
@returns(201)
@errors {404}

@endpoint GET /meetings/{meetingId}/polls/{pollId}
@required {meetingId: any, pollId: any}
@returns(200)
@errors {404}

@endpoint PUT /meetings/{meetingId}/polls/{pollId}
@required {meetingId: any, pollId: any, body: any}
@returns(204)
@errors {404}

@endpoint DELETE /meetings/{meetingId}/polls/{pollId}
@required {meetingId: any, pollId: any}
@returns(204)
@errors {404}

@endgroup

@group users
@endpoint GET /users/{userId}/recordings
@required {userId: any, from: any, to: any}
@optional {page_size: any, next_page_token: any, mc: any, trash: any}
@returns(200)
@errors {404}

@endgroup

@group meetings
@endpoint GET /meetings/{meetingId}/recordings
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint DELETE /meetings/{meetingId}/recordings
@required {meetingId: any}
@optional {action: any}
@returns(204)
@errors {404}

@endpoint DELETE /meetings/{meetingId}/recordings/{recordingId}
@required {meetingId: any, recordingId: any}
@optional {action: any}
@returns(204)
@errors {404}

@endpoint PUT /meetings/{meetingId}/recordings/status
@required {meetingId: any, body: any}
@returns(204)
@errors {404}

@endpoint PUT /meetings/{meetingId}/recordings/{recordingId}/status
@required {meetingId: any, recordingId: any, body: any}
@returns(204)
@errors {404}

@endpoint GET /meetings/{meetingId}/recordings/settings
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint PATCH /meetings/{meetingId}/recordings/settings
@required {meetingId: any, body: map}
@returns(204)
@errors {404}

@endgroup

@group metrics
@endpoint GET /metrics/meetings
@required {from: any, to: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/meetings/{meetingId}
@required {meetingId: any}
@optional {type: any}
@returns(200)

@endpoint GET /metrics/meetings/{meetingId}/participants
@required {meetingId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/meetings/{meetingId}/participants/{participantId}/qos
@required {meetingId: any, participantId: any}
@optional {type: any}
@returns(200)

@endpoint GET /metrics/meetings/{meetingId}/participants/qos
@required {meetingId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/meetings/{meetingId}/participants/sharing
@required {meetingId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/webinars
@required {from: any, to: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/webinars/{webinarId}
@required {webinarId: any}
@optional {type: any}
@returns(200)

@endpoint GET /metrics/webinars/{webinarId}/participants
@required {webinarId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/webinars/{webinarId}/participants/{participantId}/qos
@required {webinarId: any, participantId: any}
@optional {type: any}
@returns(200)

@endpoint GET /metrics/webinars/{webinarId}/participants/qos
@required {webinarId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/webinars/{webinarId}/participants/sharing
@required {webinarId: any}
@optional {type: any, page_size: any, next_page_token: any}
@returns(200)

@endpoint GET /metrics/zoomrooms
@optional {page_size: any, page_number: any}
@returns(200)

@endpoint GET /metrics/zoomrooms/{zoomroomId}
@required {zoomroomId: any, from: any, to: any}
@optional {page_size: any, page_number: any}
@returns(200)

@endpoint GET /metrics/crc
@required {from: any, to: any}
@returns(200)

@endpoint GET /metrics/im
@required {from: any, to: any}
@optional {page_size: any, next_page_token: any}
@returns(200)

@endgroup

@group report
@endpoint GET /report/daily
@optional {year: any, month: any}
@returns(200)

@endpoint GET /report/users
@required {from: any, to: any}
@optional {type: any, page_size: any, page_number: any}
@returns(200)

@endpoint GET /report/users/{userId}/meetings
@required {userId: any, from: any, to: any}
@optional {page_size: any, next_page_token: any}
@returns(200)
@errors {404}

@endpoint GET /report/meetings/{meetingId}
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint GET /report/meetings/{meetingId}/participants
@required {meetingId: any}
@optional {page_size: any, next_page_token: any}
@returns(200)
@errors {404}

@endpoint GET /report/meetings/{meetingId}/polls
@required {meetingId: any}
@returns(200)
@errors {404}

@endpoint GET /report/webinars/{webinarId}
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint GET /report/webinars/{webinarId}/participants
@required {webinarId: any}
@optional {page_size: any, next_page_token: any}
@returns(200)
@errors {404}

@endpoint GET /report/webinars/{webinarId}/polls
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint GET /report/webinars/{webinarId}/qa
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint GET /report/telephone
@required {from: any, to: any}
@optional {type: any, page_size: any, page_number: any}
@returns(200)

@endpoint GET /report/cloud_recording
@required {from: any, to: any}
@returns(200)
@errors {300}

@endgroup

@group tsp
@endpoint GET /tsp
@returns(200)

@endpoint PATCH /tsp
@required {body: any}
@returns(204)

@endgroup

@group users
@endpoint GET /users
@optional {status: any, page_size: any, page_number: any}
@returns(200)

@endpoint POST /users
@required {body: map}
@returns(201)
@errors {409}

@endpoint GET /users/{userId}
@required {userId: any}
@optional {login_type: any}
@returns(200)
@errors {404}

@endpoint PATCH /users/{userId}
@required {userId: any, body: map}
@returns(204)
@errors {404}

@endpoint DELETE /users/{userId}
@required {userId: any}
@optional {action: any, transfer_email: any, transfer_meeting: any, transfer_webinar: any, transfer_recording: any}
@returns(204)
@errors {404}

@endpoint GET /users/{userId}/assistants
@required {userId: any}
@returns(200)
@errors {404}

@endpoint POST /users/{userId}/assistants
@required {userId: any, body: map}
@returns(201)
@errors {404}

@endpoint DELETE /users/{userId}/assistants
@required {userId: any}
@returns(204)
@errors {404}

@endpoint DELETE /users/{userId}/assistants/{assistantId}
@required {userId: any, assistantId: any}
@returns(204)
@errors {404}

@endpoint GET /users/{userId}/schedulers
@required {userId: any}
@returns(200)
@errors {404}

@endpoint DELETE /users/{userId}/schedulers
@required {userId: any}
@returns(204)
@errors {404}

@endpoint DELETE /users/{userId}/schedulers/{schedulerId}
@required {userId: any, schedulerId: any}
@returns(204)
@errors {404}

@endpoint POST /users/{userId}/picture
@required {userId: any, pic_file: any}
@returns(201)
@errors {404}

@endpoint GET /users/{userId}/settings
@required {userId: any}
@optional {login_type: any}
@returns(200)
@errors {404}

@endpoint PATCH /users/{userId}/settings
@required {userId: any, body: map}
@returns(204)
@errors {404}

@endpoint PUT /users/{userId}/status
@required {userId: any, body: map}
@returns(204)
@errors {404}

@endpoint PUT /users/{userId}/password
@required {userId: any, body: map}
@returns(204)
@errors {404}

@endpoint GET /users/{userId}/permissions
@required {userId: any}
@returns(200)
@errors {404}

@endpoint GET /users/{userId}/pac
@required {userId: any}
@returns(200)
@errors {404}

@endpoint GET /users/{userId}/tsp
@required {userId: any}
@returns(200)
@errors {404}

@endpoint POST /users/{userId}/tsp
@required {userId: any, body: map}
@returns(201)

@endpoint GET /users/{userId}/tsp/{tspId}
@required {userId: any, tspId: any}
@returns(200)

@endpoint PATCH /users/{userId}/tsp/{tspId}
@required {userId: any, tspId: any, body: map}
@returns(204)

@endpoint DELETE /users/{userId}/tsp/{tspId}
@required {userId: any, tspId: any}
@returns(204)

@endpoint GET /users/{userId}/token
@required {userId: any}
@optional {type: any}
@returns(200)
@errors {404}

@endpoint DELETE /users/{userId}/token
@required {userId: any}
@returns(204)
@errors {404}

@endpoint PUT /users/{userId}/email
@required {userId: any, body: map}
@returns(204)
@errors {404}

@endpoint GET /users/zpk
@required {zpk: any}
@returns(200)

@endpoint GET /users/email
@required {email: any}
@returns(200)

@endpoint GET /users/vanity_name
@required {vanity_name: any}
@returns(200)

@endpoint GET /users/{userId}/webinars
@required {userId: any}
@optional {page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /users/{userId}/webinars
@required {userId: any, body: map}
@returns(201)
@errors {404}

@endgroup

@group webinars
@endpoint GET /webinars/{webinarId}
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint PATCH /webinars/{webinarId}
@required {webinarId: any, body: map}
@returns(204)
@errors {404}

@endpoint DELETE /webinars/{webinarId}
@required {webinarId: any}
@optional {occurrence_id: any}
@returns(204)
@errors {404}

@endpoint PUT /webinars/{webinarId}/status
@required {webinarId: any, body: any}
@returns(204)
@errors {404}

@endpoint GET /webinars/{webinarId}/panelists
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint POST /webinars/{webinarId}/panelists
@required {webinarId: any, body: map}
@returns(201)
@errors {404}

@endpoint DELETE /webinars/{webinarId}/panelists
@required {webinarId: any}
@returns(204)
@errors {404}

@endpoint DELETE /webinars/{webinarId}/panelists/{panelistId}
@required {webinarId: any, panelistId: any}
@returns(204)
@errors {404}

@endpoint GET /webinars/{webinarId}/registrants
@required {webinarId: any}
@optional {occurrence_id: any, status: any, page_size: any, page_number: any}
@returns(200)
@errors {404}

@endpoint POST /webinars/{webinarId}/registrants
@required {webinarId: any, body: map}
@optional {occurrence_ids: any}
@returns(201)
@errors {404}

@endpoint PUT /webinars/{webinarId}/registrants/status
@required {webinarId: any, body: any}
@optional {occurrence_id: any}
@returns(204)
@errors {404}

@endgroup

@group past_webinars
@endpoint GET /past_webinars/{webinarId}/instances
@required {webinarId: any}
@returns(200)
@errors {404}

@endgroup

@group webinars
@endpoint GET /webinars/{webinarId}/polls
@required {webinarId: any}
@returns(200)
@errors {404}

@endpoint POST /webinars/{webinarId}/polls
@required {webinarId: any, body: any}
@returns(201)
@errors {404}

@endpoint GET /webinars/{webinarId}/polls/{pollId}
@required {webinarId: any, pollId: any}
@returns(200)
@errors {404}

@endpoint PUT /webinars/{webinarId}/polls/{pollId}
@required {webinarId: any, pollId: any, body: any}
@returns(204)
@errors {404}

@endpoint DELETE /webinars/{webinarId}/polls/{pollId}
@required {webinarId: any, pollId: any}
@returns(204)
@errors {404}

@endgroup

@group webhooks
@endpoint PATCH /webhooks/options
@required {body: any}
@returns(204)
@errors {404}

@endpoint GET /webhooks
@returns(200)
@errors {404}

@endpoint POST /webhooks
@required {body: map}
@returns(201)
@errors {404}

@endpoint GET /webhooks/{webhookId}
@required {webhookId: any}
@returns(200)
@errors {404}

@endpoint PATCH /webhooks/{webhookId}
@required {webhookId: any, body: map}
@returns(204)
@errors {404}

@endpoint DELETE /webhooks/{webhookId}
@required {webhookId: any}
@returns(204)
@errors {404}

@endgroup

@end