Ticket details

Registrant information

Event Registrants

* `PRIVATE_UNRESTRICTED` - Private and unrestricted.
* `PRIVATE_RESTRICTED` - Private and restricted.


The type of attendee experience for the event.
* `Virtual` - virtual attendees only.
* `In-person` - in-person attendees only.
* `Hybrid` - both in-person and virtual attendees.

Attendees from the countries listed here will not be allowed to register to the event.

The [country's code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#countries).

The start and end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.

The contact person's email address for the event.

The end time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is a read only field.

The event types as enum:
* `CONFERENCE` - Multi session events.
* `SIMPLE_EVENT` - Single event session.
* `RECURRING` - Recurring Sessions event.


The end time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.

The start time of the lobby in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.

This value is required only for a single session event.
* `MEETING` - Meeting.
* `WEBINAR` - Webinar.


The physical location of the event. This field is applicable for hybrid and in-person events only.

Information about [recurring sessions](https://marketplace.zoom.us/docs/api-reference/other-references/recurrence-object-definitions).

The recurring session's final ending date and time before it is canceled, in UTC format.

The number of times the recurring session will occur before it is canceled.

The day of the month on which the recurring monthly session occurs. The value ranges from 1 to 31.

The week of the month on which a recurring session occurs:
* `-1` — The last week of the month.
* `1` — The first week.
* `2` — The second week.
* `3` — The third week.
* `4` — The fourth week.

The day of the week on which the recurring monthly session is scheduled:
* `1` — Sunday
* `2` — Monday
* `3` — Tuesday
* `4` — Wednesday
* `5` — Thursday
* `6` — Friday
* `7` — Saturday

The session's repeat interval:
* For daily intervals, a max of `90` days.
* For a weekly interval, a max of `12` weeks.
* For monthly intervals, a max of `3` months.

The type of recurring session:
* `1` — Daily.
* `2` — Weekly.
* `3` — Monthly.

A comma-separated list of the days of the week on which the recurring weekly session occurs:
* `1` — Sunday
* `2` — Monday
* `3` — Tuesday
* `4` — Wednesday
* `5` — Thursday
* `6` — Friday
* `7` — Saturday

The start time of the event in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ` this is read only field.

The event status:
Options:
* `PUBLISHED` - Published event
* `DRAFT` - Draft event

This field displays under the event detail page image.

The timezone of the event.   For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).

Data

Events

The meeting's agenda. This value has a maximum length of 2,000 characters.

The ID of the user who scheduled this meeting on behalf of the host.

Whether to generate a default password using the user's settings. This value defaults to `false`.

If this value is `true` and the user has the PMI setting enabled with a password, then the user's meetings will use the PMI password. It will **not** use a default password.

The meeting's scheduled duration, in minutes. This field is only used for scheduled meetings (`2`).

Encrypted passcode for third party endpoints (H323/SIP).

ID of the user who is set as host of meeting.

[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number.

URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.

The password required to join the meeting. By default, a password can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters.
* If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the password **must** meet those requirements.
* If password requirements are enabled, use the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API to get the requirements.

[Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.

Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time):
* `true` — Create a prescheduled meeting.
* `false` — Create a regular meeting.

Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with "end_times".)

Select how many times the meeting should recur before it is canceled. The default recurrence is 50 times. To support meetings recurring more than 50 times, contact Zoom support. Cannot be used with "end_date_time".

Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.

For instance, if you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.

Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.** `-1` - Last week of the month. `1` - First week of the month. `2` - Second week of the month. `3` - Third week of the month. `4` - Fourth week of the month.

Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field.

 `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.

Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`.

For a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.



Recurrence meeting types: `1` - Daily. `2` - Weekly. `3` - Monthly.

This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat. The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `"1"` as the value of this field. **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `"1,3"` as the value of this field.

 `1` - Sunday. `2` - Monday. `3` - Tuesday. `4` - Wednesday. `5` - Thursday. `6` - Friday. `7` - Saturday.

The email address or user ID of the user to schedule a meeting for.

The meeting's start time. This field is only used for scheduled and/or recurring meetings with a fixed time. This supports local time and GMT formats.
* To set a meeting's start time in GMT, use the `yyyy-MM-ddTHH:mm:ssZ` date-time format. For example, `2020-03-31T12:02:00Z`.
* To set a meeting's start time using a specific timezone, use the `yyyy-MM-ddTHH:mm:ss` date-time format and specify the [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) in the `timezone` field. If you do not specify a timezone, the `timezone` value defaults to your Zoom account's timezone. You can also use `UTC` for the `timezone` value.

<aside>The <code>start_url</code> of a Meeting is a URL using which a host or an alternative host can start the Meeting. 

The expiration time for the <code>start_url</code> field listed in the response of the [**Create a meeting**](/docs/api-reference/zoom-api/methods#operation/meetingCreate) API is two hours for all regular users. 
	
For users created using the <code>custCreate</code> option via the [**Create users**](/docs/api-reference/zoom-api/methods#operation/userCreate) API, the expiration time of the <code>start_url</code> field is 90 days.
	
For security reasons, to retrieve the updated value for the <code>start_url</code> field programmatically (after the expiry time), you must call the [**Get a meeting](/docs/api-reference/zoom-api/methods#operation/meeting) API and refer to the value of the <code>start_url</code> field in the response.</aside> This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.

The **account admin meeting template** ID with which to schedule a meeting using a [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). For a list of account admin-provided meeting templates, use the [**List meeting templates**](/docs/api-reference/zoom-api/methods#operation/listMeetingTemplates) API.
* At this time, this field **only** accepts account admin meeting template IDs.
* To enable the account admin meeting templates feature, [contact Zoom support](https://support.zoom.us/hc/en-us).

The timezone to assign to the `start_time` value. This field is only used for scheduled meetings (`2`).

For a list of supported timezones and their format, refer to our [timezone list documentation](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones).

Information about the meeting's tracking fields.

The type of meeting:
* `1` — An instant meeting.
* `2` — A scheduled meeting.
* `3` — A recurring meeting with no fixed time.
* `8` — A recurring meeting with fixed time.

Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). You can retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.


Meetings

Meeting ID - also known as the meeting number.

Number of recording files returned in the response of this API call. This includes the `recording_files` and `participant_audio_files` files.

Recording file List

The cloud recording's password to be used in the URL. This recording's password can be directly spliced in `play_url` or `share_url` with `?pwd=` to access and play. For example, 'https://zoom.us/rec/share/**************?pwd=yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'. If you want to use this field, please contact Zoom support.

The total file size of the recording. This includes the `recording_files` and `participant_audio_files` files.

The recording's associated type of meeting or webinar:

If the recording is of a meeting:
* `1` — Instant meeting.
* `2` — Scheduled meeting.
* `3` — A recurring meeting with no fixed time.
* `4` — A meeting created via PMI (Personal Meeting ID).
* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC).
* `8` - Recurring meeting with a fixed time.

If the recording is of a webinar:
* `5` — A webinar.
* `6` — A recurring webinar without a fixed time
* `9` — A recurring webinar with a fixed time.

If the recording is **not** from a meeting or webinar:

* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.

Unique Meeting Identifier. Each instance of the meeting will have its own UUID.

Recordings

The event authentication method for the attendee:
* `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication

Attendees

Session Attendees

The list of alternative hosts. Alternative hosts can start the session on the hosts behalf. The &quot;Alternative Host&quot; ticket is auto-assigned to alternative hosts.

The email address of the alternative host.

The type of attendee experience for the event.
* `Virtual` &mdash; virtual attendees only.
* `In-person` &mdash; in-person attendees only.
* `Hybrid` &mdash; both in-person and virtual attendees.

The list of audience type tags for the session.

Whether the session chat in the lobby is enabled.
*Attendees need to have Zoom Chat enabled by their account admin to view and participate in the conference chat.

This is a description of the session. This field does NOT support the Richtext Description field in the UI.

The end time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.

Whether the session is marked as featured in the event lobby.

The languages available for interpretations.

Interpretation Context

Whether the session is hosted by a sponsor.

The list of level type tags for the session.

The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-) in **long** format(represented as int64 data type in JSON), also known as the meeting number. Applicable, if the session type is of meeting ( i.e type = 0). This ID is null for an unpublished event.

The speaker joins session as an attendee in a meeting session and as a panelist in a webinar session. Panelist can mute or unmute themselves, start or stop their own video, view and respond to all questions and answers.

The list of product type tags for the session.

The previously recorded file's ID for `simulive`.

The speakers joins a session as an attendee in a meeting session and as panelists in a webinar session.

The speaker joins a session as an attendee in a meeting session and as a panelist in a webinar session.

The session speaker

The sign interpretation languages that are available.

The start time of the session in UTC. The format should be `yyyy-MM-dd`T`HH:mm:ssZ`.

The timezone of the event.
For a list of supported timezones and their formats, see our [timezone list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones).

The track or classification that separates events into different categories. Tickets for these tracks link to specific sessions. Only ticket holders can join these sessions.

The type of session:
* `0`- meeting.
* `2`- webinar.

Whether the session is visible in landing page.

Whether the session is visible in event lobby.

The webinar ID in **long** format(represented as int64 data type in JSON), also known as the webinar number.
Applicable, if the session type is of webinar ( i.e type = 2). This ID is null for an unpublished event.

Sessions

The list of sessions that display in the main lobby. The value is an array of session IDs or *ALL* .  *ALL* refer all the sessions in the event.

Whether the ticket type is restricted to certain Zoom accounts.

The ticket type is restricted to these specific domains. The maximum domains you can pass in the array is 50.

The type of attendee experience for the event.
* `virtual`  virtual attendees only
* `in-person` in-person attendees only
* `hybrid`  both in-person and virtual attendees

The registration restricted to users by email addresses. Only these users are allowed to register and these email addresses will receive an email invitation.

The list of session IDs allowed for this ticket type or *ALL*  *ALL* refer all the sessions in the event.

Ticket Types

The event authentication method for the ticket:
* `zoom_account` Zoom account holder  * `zoom_account_otp` Zoom account holder with OTP  * `corporate_idp` Corporate IDP  * `no_auth` No authentication

The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).

The email address used for the registration.

A unique join link created for the ticket.

A set of unique alphanumeric characters that references the external ticket ID.

A set of unique alphanumeric characters that references the ticket ID.

The ticket role type:
* `normal` The normal ticket
* `alternative_host` The alternative host ticket
* `panelist` The panelist ticket
* `bind_meeting` The bind meeting ticket
* `speaker` The speaker ticket
* `interpreter` The interpreter ticket
* `sponsor` The sponsor ticket
* `host` The host ticket
* `moderator` The moderator ticket
* `expo_booth_owner` The expo booth owner ticket
* `attendee_without_order` The attendee without order ticket
* `pre_registration` The pre-registration ticket
* `company_zoom_room` The company Zoom Room ticket
* `moderator_allhost` The moderator all host ticket
* `hub_host` The hub host ticket
* `hub_owner` The hub owner ticket
* `subscription` The subscription ticket

Tickets

CMS ID of user, only enabled for Kaltura integration.

The date and time at which this user's latest login type was created.

The user's display name. Cannot contain more than 10 Chinese characters.

The employee's unique ID. This field only returns when:
* SAML single sign-on (SSO) is enabled.
* The `login_type` value is `101` (SSO).

The Zoom One plan option. `16` - Zoom One Business Plus with US/CA Unlimited. `32` - Zoom One Business Plus with UK/IR Unlimited. `64` - Zoom One Business Plus with AU/NZ Unlimited. `128` - Zoom One Business Plus with Japan Unlimited. `33554432` - Zoom One Business Plus with Global Select. The Zoom One plan option for Gov accounts: `16` - Zoom One Business Plus.

Whether the user has the **Zoom Phone** feature enabled.

The user's first name. Cannot contain more than 5 Chinese characters.

Default language for the Zoom Web Portal.

The user's last name. Cannot contain more than 5 Chinese characters.

The user's login method:

`0` — Facebook OAuth`1` — Google OAuth`24` — Apple OAuth`27` — Microsoft OAuth`97` — Mobile device`98` — RingCentral OAuth`99` — API user`100` — Zoom Work email`101` — Single Sign-On (SSO)

The following login methods are only available in China:

`11` — Phone number`21` — WeChat`23` — Alipay

User password. Only used for the "autoCreate" function. The password has to have a minimum of 8 characters and maximum of 32 characters. By default (basic requirement), password must have at least one letter (a, b, c..), at least one number (1, 2, 3...) and include both uppercase and lowercase letters. It should not contain only one identical character repeatedly ('11111111' or 'aaaaaaaa') and it cannot contain consecutive characters ('12345678' or 'abcdefgh').

**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API and referring to the `password_requirement` field present in the `security` object.

**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead of this field. User's country for Company Phone Number.

**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead of this field. User's phone number.

The Zoom United type. The license option:
* `1` — Zoom United Pro-United with US/CA Unlimited.
* `2` — Zoom United Pro-United with UK/IR Unlimited.
* `4` — Zoom United Pro-United with AU/NZ Unlimited.
* `8` — Zoom United Pro-United with Global Select.
* `16` — Zoom United Pro-United with Zoom Phone Pro.
* `32` — Zoom United Biz-United with US/CA Unlimited.
* `64` — Zoom United Biz-United with UK/IR Unlimited.
* `128` — Zoom United Biz-United with AU/NZ Unlimited.
* `256` — Zoom United Biz-United with Global Select.
* `512` — Zoom United Biz-United with Zoom Phone Pro.
* `1024` — Zoom United Ent-United with US/CA Unlimited.
* `2048` — Zoom United Ent-United with UK/IR Unlimited.
* `4096` — Zoom United Ent-United with AU/NZ Unlimited.
* `8192` — Zoom United Ent-United with Global Select.
* `16384` — Zoom United Ent-United with Zoom Phone Pro.
* `32768` — Zoom United Pro-United with JP Unlimited.
* `65536` — Zoom United Biz-United with JP Unlimited.
* `131072` — Zoom United Ent-United with JP Unlimited.

[Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi).

The user's display pronouns setting:
* `1` — Ask the user every time they join meetings and webinars.
* `2` — Always display pronouns in meetings and webinars.
* `3` — Do not display pronouns in meetings and webinars.

Unique identifier of the [role](/docs/api-reference/zoom-api/methods#operation/roles) assigned to the user.

User's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name.

User type. `1` - Basic. `2` - Licensed. `99` - None (this can only be set with `ssoCreate`).

Displays `true` if user has enabled a [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi) for instant meetings, `false` otherwise.

The date and time at which this user was created.

Personal meeting room URL, if the user has one.

Displays whether user is verified or not. 
`1` - Account verified. 
`0` - Account not verified.

The user's Zoom One plan option. `4` - Zoom One Enterprise. `8` - Zoom One Enterprise Plus. `16` - Zoom One Business Plus with US/CA Unlimited. `32` - Zoom One Business Plus with UK/IR Unlimited. `64` - Zoom One Business Plus with AU/NZ Unlimited. `128` - Zoom One Business Plus with Japan Unlimited. `33554432` - Zoom One Business Plus with Global Select. The Zoom One plan option for Gov accounts: `4` - Zoom One Enterprise. `8` - Zoom One Enterprise Plus. `16` - Zoom One Business Plus.

Output schema

Users

The registrant's language preference for confirmation emails:
* `en-US` — English (US)
* `de-DE` — German (Germany)
* `es-ES` — Spanish (Spain)
* `fr-FR` — French (France)
* `jp-JP` — Japanese
* `pt-PT` — Portuguese (Portugal)
* `ru-RU` — Russian
* `zh-CN` — Chinese (PRC)
* `zh-TW` — Chinese (Taiwan)
* `ko-KO` — Korean
* `it-IT` — Italian (Italy)
* `vi-VN` — Vietnamese
* `pl-PL` — Polish
* `Tr-TR` — Turkish

The registrant's number of employees:
* `1-20`
* `21-50`
* `51-100`
* `101-500`
* `500-1,000`
* `1,001-5,000`
* `5,001-10,000`
* `More than 10,000`

The registrant's purchasing time frame:
* `Within a month`
* `1-3 months`
* `4-6 months`
* `More than 6 months`
* `No timeframe`

The registrant's role in the purchase process:
* `Decision Maker`
* `Evaluator/Recommender`
* `Influencer`
* `Not involved`

Unique Identifier of the tracking source.

The registrant's status:
* `approved` — Registrant is approved.
* `denied` — Registrant is denied.
* `pending` — Registrant is waiting for approval.

Webinar Registrants

Webinar ID in "**long**" format(represented as int64 data type in JSON), also known as the webinar number.

URL to join the Webinar. This URL should only be shared with the users who should be invited to the Webinar.

Recurrence Webinar

<aside>The <code>start_url</code> of a Webinar is a URL using which a host or an alternative host can start the Webinar. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the Webinar. 

The expiration time for the <code>start_url</code> field listed in the response of the [**Create a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API is two hours for all regular users. 
	
For users created using the <code>custCreate</code> option via the [**Create users**](/docs/api-reference/zoom-api/methods#operation/userCreate) API, the expiration time of the <code>start_url</code> field is 90 days.
	
For security reasons, to retrieve the latest value for the <code>start_url</code> field programmatically (after expiry), you must call the [**Get a webinar**](/docs/api-reference/zoom-api/methods#operation/webinar) API and refer to the value of the <code>start_url</code> field in the response.</aside>

Unique Webinar ID. Each Webinar instance will generate its own Webinar UUID (i.e., after a Webinar ends, a new UUID will be generated for the next instance of the Webinar). You can retrieve a list of UUIDs from past Webinar instances using the [**List past webinar instances**](/docs/api-reference/zoom-api/methods#operation/pastWebinars) API. [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.



Webinars

Zoom

Get an account's archived meeting or webinar files.

 Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements.

 **Prerequisites:**
* The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).

**Scopes:** `recording:read:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

List archived files

Get statistics about an account's archived meeting or webinar files.

 Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA and other compliance requirements.

 **Prerequisites:**
* The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).

**Scopes:** `recording:read:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

Get archived file statistics

Update an archived file's auto-delete status.

 **Prerequisites:**
* [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) must enable the [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) for your account.
* Open the disabling auto-delete feature in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open.

**Scopes:** `recording:write`,`recording:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

Update an archived file's auto-delete status

Return a specific meeting instance's [archived files](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators).

 **Prerequisites:**
* The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).

**Scopes:** `recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

Get a meeting's archived files

Use this API to delete all of a meeting's archived files.

 **Prerequisites:**
* The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).

**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Delete a meeting's archived files

Returns all of a meeting's [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4).

 Use the `download_url` property listed in the response to download the recording files. To access a passcode-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header.

 Example: `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`

**Scopes:** `recording:read`,`phone_recording:read:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

Get meeting recordings

Delete all recording files of a meeting.


**Prerequisites**:
* Cloud Recording should be enabled on the user's account.


**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Delete meeting recordings

Use this API to return a meeting recording's [analytics details](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example,

 `curl -H &quot;Authorization: Bearer &lt;ACCESS_TOKEN&gt;&quot; https://{{base-domain}}/rec/archive/download/xyz`



**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

Get Meeting Recording's Analytics Details

Use this API to return a meeting recording's [analytics summary](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example,

 `curl -H &quot;Authorization: Bearer &lt;ACCESS_TOKEN&gt;&quot; https://{{base-domain}}/rec/archive/download/xyz`



**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

Get Meeting Recording's Analytics Summary

Use this API to list registrants of a past meeting's [on-demand cloud recordings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-recordings). Users must [register](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view the recordings.


**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

List recording registrants

Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view these recordings.

Use this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.


**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Create a recording registrant

For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.

Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.


**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Get registration questions

For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.

Use this API to update registration questions that are to be answered by users while registering to view a recording.


**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Update registration questions

A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording.
Use this API to update a registrant's status.



**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

Update registrant's status

Retrieves settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).



**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

Get meeting recording settings

Updates settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).

**Scopes:** `recording:write`,`recording:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`

Update meeting recording settings

Delete a specific recording file from a meeting.&lt;p style=&quot;background-color:#e1f5fe; color:#01579b; padding:8px&quot;&gt; &lt;b&gt;Note:&lt;/b&gt; To use this API, you must enable the &lt;b&gt;The host can delete cloud recordings&lt;/b&gt; setting. You can find this setting in the &lt;b&gt;Recording&lt;/b&gt; tab of the &lt;b&gt;Settings&lt;/b&gt; interface in the [Zoom web portal](https://zoom.us/).&lt;/p&gt;



**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Delete a meeting recording file

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.


**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Recover a single recording

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.

**Prerequisites**:
* A Pro user with Cloud Recording enabled.

**Scopes:** `recording:write:admin`,`recording:write`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`

Recover meeting recordings

Lists all [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) for a user.

For user-level apps, pass the [`me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. To access a user's passcode protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a bearer token in the authorization header.

Example: `curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz`

**Prerequisites:**
* Must have a Pro or a higher plan.
* Must enable Cloud Recording on the user's account.

**Scopes:** `recording:read:admin`,`recording:read`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

List all recordings

This API lets you list devices.



**Scopes:** `device:read:admin`,`device:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`

List devices

This Device API lets you add a new device to Zoom Account.

**Scope:** `device:write:admin`

 **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`

**Scopes:** `device:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

Add new device

Retrieve a device's details.

**Scopes:** `device:read:admin`,`device:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`

Get device detail

Delete a device from a Zoom account.

**Prerequisites:**
* Device must be enrolled in ZMD (Zoom Device Management)

**Scopes:** `device:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`

Delete device

Change device name.

**Prerequisites:**
* Device must be enrolled in ZMD (Zoom Device Management)

**Scopes:** `device:write:admin`

**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`

Field Name	API Key	Type
Query	query	object
Page Size	query.page_size	integer
Next Page Token	query.next_page_token	string
From	query.from	string
To	query.to	string

Field Name	API Key	Type	Description
From	from	string	The queried start date.
Meetings	meetings	array of items	Information about the meeting or webinar.
Account Name	item.account_name	string	The user's account name.
Archive Files	item.archive_files	array of items	Information about the archive files.
Download Url	item.download_url	string	The URL to download the the archive file. OAuth apps If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example, `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'` Note: This field does not return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.

Zoom API Integration Profile

List archived files in Zoom API

Build every single integration your customers need with AI