Access Token

Refresh Token

Zoom

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

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.

Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences.

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.

Indicates whether the [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) is visible in the meeting scheduling options in the Zoom Web Portal or not.

`true`: Tracking field is visible. 

`false`: Tracking field is not visible to the users when they look at the meeting details in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only.

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.

The time at which recording was deleted. Returned in the response only for trash query.

The URL at which to download the the recording.

**JWT apps**

To access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. For example:

`https://{{base-domain}}/rec/download/{{path-to-file-download}}?access_token={{JWT-token}}`

**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?access_token={{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.

**Note:** We recommend that you send the access_token as a Bearer token in the Authorization header, for example: "Authorization": "Bearer <ACCESS_TOKEN>”.

The file extension type of the recording file.

The file path to the On-Premise account recording.

**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field.

The recording file type. The value of this field could be one of the following: 
`MP4`: Video file of the recording. `M4A` Audio-only file of the recording. `TIMELINE`: Timestamp file of the recording in JSON file format. To get a timeline file, the "Add a timestamp to the recording" setting must be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone, set on their Zoom profile.
 `TRANSCRIPT`: Transcription file of the recording in VTT format. `CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting. `CC`: File containing closed captions of the recording in VTT file format. `CSV`: File containing polling data in csv format.

 

A recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties: 
	`id`, `status`, `file_size`, `recording_type`, and `play_url`. `SUMMARY`: Summary file of the recording in JSON file format.

The recording file ID. Included in the response of general query.

The URL using which a recording file can be played.

The recording end time. Response in general query.

The recording type. `shared_screen_with_speaker_view(CC)` `shared_screen_with_speaker_view` `shared_screen_with_gallery_view` `speaker_view` `gallery_view` `shared_screen` `audio_only` `audio_transcript` `chat_file` `active_speaker` `poll` `timeline` `closed_caption` `audio_interpretation` `summary` `summary_next_steps` `summary_smart_chapters` `sign_interpretation`

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.

Whether the speaker has access to edit the session information.

Whether the speaker can act as an alternative host for the session.

The role of the speaker in a meeting:
* `0` ALTERNATIVE_HOST
* `1` ATTENDEE
* `2` PANELIST


Whether to show the speaker information under session details.

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 phone number's country code. For example, for United States phone numbers, this will be a `+1` value.

The phone number's [country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). For example, if the phone number provided in the `number` field is a Brazil-based number, this will be the `BR` value.

The phone number's label:
* `Mobile`
* `Office`
* `Home`
 * `Fax`

Whether Zoom has verified the 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 custom question's response value. This has a limit of 128 characters.

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

Use this API to add a [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037) to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account.

**Note:** This API does not support adding a calendar resource to a Google calendar service.

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

 **Prerequisites:**
* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.

Add A Calendar Resource To A Calendar Service

Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account.

**Prerequisites:**
* Account owner or admin permissions.
* Zoom Rooms Version 4.0 or higher 
**Scopes:** `room:write:admin` 


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

Add A Location

Create and submit a user's registration to a meeting. See [Customizing webinar registration](https://support.zoom.us/hc/en-us/articles/202835649-Customizing-webinar-registration) for details on how to set the requirements for these fields. Note that there is a maximum limit of 4,999 registrants per meeting and users will see an error if the meeting's capacity is reached.

 **Scopes:** `meeting:write:admin`, `meeting:write` **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`

 **Prerequisites:**
* The host must be a **Licensed** user type.

Add A Meeting Registrant

Add a user's TSP account. 
**Scopes:** `tsp:write:admin` `tsp:write` 

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

Add A User S Tsp Account

Use this API to create and submit a user's registration for a webinar. Zoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow hosts to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the webinar.

**Scopes:** `webinar:write:admin`, `webinar:write` **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`

**Prerequisites:**
* A Pro or higher plan with the Webinar add-on.

Add A Webinar Registrant

Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account. 
**Prerequisites:** 
* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license. 
**Scopes**: `room:write:admin` 
 **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`

Add A Zoom Room

Use this API to assign assistants to a user. In the request body, provide either the user's ID or the user's email address. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.

 Assistants are users to whom the current user has assigned the [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meetings on behalf of the current user. Assistants can also manage and act as an alternative host for the user's meetings if the administrator has enabled the [co-host feature](https://support.zoom.us/hc/en-us/articles/206330935-Enabling-and-adding-a-co-host) on the account.

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

**Prerequisites:**
* The user and the assistant must have a Licensed or an On-prem license.
* Assistants must be under the current user's account or in the same organization with the current user's account.

Add Assistants

Use this API to add members to a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management).

**Prerequisite**: Pro or higher account. **Scopes:** `contact_group:write:admin` **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`

Add Contact Group Members

Use this API to add administrators to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.

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

**Prerequisites:**
* A Pro, Business, or Education account

Add Group Admins

Use this API to add users to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in your account.

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

**Prerequisites:**
* A Pro, Business, or Education account

Add Group Members

Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account. 
**Scope:** `imgroup:write:admin` 

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

Add Im Directory Group Members

Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar. Use this API to [add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar. 
**Scopes:** `webinar:write:admin` `webinar:write` 
 **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` 


**Prerequisites:**
* Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).

Add Panelists

Use this API to register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration). 

**Prerequisites:** 
* The webinar host must be a Licensed user.
* The webinar should be of type `5`, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API. 
**Scope:** `webinar:write`, `webinar:write:admin` 
**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`

	List	Find by ID	Create	Update	Delete
Sessions	✅	✅	✅	✅	✅
Tickets	✅	✅	✅	✅	✅
Webinars	✅	✅	✅	✅	✅
Events	✅	✅	✅	✅	➖
Webinar Registrants	✅	✅	✅	➖	✅
Ticket Types	✅	➖	✅	✅	➖

Zoom integration connector

Managed authentication

Execute Zoom operations on behalf of your customers

Add A Calendar Resource To A Calendar Service

Add A Location

Add A Meeting Registrant

Add A User S Tsp Account

Add A Webinar Registrant

Add A Zoom Room

Work with Zoom data collections

Trigger integrations on Zoom events

Data Record Created

Data Record Updated

Data Record Deleted

Try our AI-powered integration development environment for free

Zoom integration connector

Managed authentication

Execute Zoom operations on behalf of your customersself.__wrap_n!=1&&self.__wrap_b(":Rat56:",1)

Add A Calendar Resource To A Calendar Service

Add A Location

Add A Meeting Registrant

Add A User S Tsp Account

Add A Webinar Registrant

Add A Zoom Room

Work with Zoom data collectionsself.__wrap_n!=1&&self.__wrap_b(":Rb556:",1)

Trigger integrations on Zoom eventsself.__wrap_n!=1&&self.__wrap_b(":Rbd56:",1)

Data Record Created

Data Record Updated

Data Record Deleted

Try our AI-powered integration development environment for free

Execute Zoom operations on behalf of your customers

Work with Zoom data collections

Trigger integrations on Zoom events