Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    Get A User

    Use this API to view a user's information on a Zoom account. For user-level apps, pass the me value instead of the userId parameter.

    Note: Users who have not activated their account will have a pending status. These users' created_at timestamp will also display the time at which the API call was made, not the account's creation date.

    Scopes: user:read:admin, user:read, user_info:read

    • Note: The user_info:read scope is only available when you pass the me value for the $userId value.

    Rate Limit Label: Light

    Input

    type: object properties: parameters: type: object properties: userId: oneOf: - type: string example: 6dfgdfgdg444447b0egga - type: string format: email example: [email protected] - type: string enum: - me example: me description: >- The user ID or email address of the user. For user-level apps, pass the `me` value. login_type: type: integer enum: - 0 - 1 - 11 - 21 - 23 - 24 - 27 - 97 - 98 - 99 - 100 - 101 example: 101 description: |- 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 encrypted_email: default: false type: boolean example: false description: >- Whether the email address passed for the `userId` value is an encrypted email address: * `true` — The email address is encrypted. * `false` — The email address is not encrypted. If you do not query this parameter, this value defaults to null (`false`). search_by_unique_id: type: boolean example: true description: |- Whether the queried `userId` value is an employee unique ID: * `true` — The queried ID is an employee's unique ID. * `false` — The queried ID is not an employee's unique ID. This value defaults to `false` (null). required: - userId title: Parameters

    Output

    type: object properties: id: description: User ID. type: string example: zJKyaiAyTNC-MWjiWC18KQ created_at: description: The date and time at which this user's latest login type was created. format: date-time type: string example: '2018-10-31T04:32:37Z' deprecated: true dept: description: Department. type: string example: Developers email: description: User's email address. type: string example: [email protected] first_name: description: User's first name. maxLength: 64 type: string example: Jill last_client_version: description: User last login client version. type: string example: 5.9.6.4993(mac) last_login_time: description: User last login time. format: date-time type: string example: '2021-05-05T20:40:30Z' last_name: description: User's last name. maxLength: 64 type: string example: Chill pmi: description: >- [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). format: int64 type: integer example: 3542471135 role_name: description: >- User's [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name. type: string example: Admin timezone: description: The time zone of the user. type: string example: Asia/Shanghai type: description: >- User's plan type:<br>`1` - Basic.<br>`2` - Licensed.<br>`99` - None (this can only be set with `ssoCreate`). enum: - 1 - 2 - 99 type: integer example: 1 use_pmi: default: false description: >- 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. type: boolean example: false display_name: description: User's display name. maxLength: 128 type: string example: Jill Chill account_id: description: User's account ID. type: string example: q6gBJVO5TzexKYTb_I2rpg account_number: description: The user's account number. format: int64 type: integer example: 10009239 cms_user_id: description: CMS ID of user, only enabled for Kaltura integration. type: string example: KDcuGIm1QgePTO8WbOqwIQ company: description: User's company. type: string example: Jill user_created_at: description: The date and time at which this user was created. format: date-time type: string example: '2018-10-31T04:32:37Z' custom_attributes: type: object properties: key: description: Identifier for the custom attribute. type: string example: cbf_cywdkexrtqc73f97gd4w6g name: description: Name of the custom attribute. type: string example: A1 value: description: Value of the custom attribute. type: string example: '1' employee_unique_id: description: |- The employee's unique ID. This field only returns when: * SAML single sign-on (SSO) is enabled. * The `login_type` value is `101` (SSO). type: string example: HqDyI037Qjili1kNsSIrIg group_ids: description: 'IDs of the web groups user belongs to. ' type: array items: type: string example: RSMaSp8sTEGK0_oamiA2_w im_group_ids: description: IM IDs of the groups user belongs to. type: array items: type: string example: t-_-d56CSWG-7BF15LLrOw jid: type: string example: [email protected] job_title: description: User's job title. type: string example: API Developer language: description: Default language for the Zoom Web Portal. type: string example: en-US location: description: User's location. type: string example: Paris login_types: description: >- The user's login method: `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO) The following login methods are only available in China: `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay type: array items: type: integer enum: - 0 - 1 - 11 - 21 - 23 - 24 - 27 - 97 - 98 - 99 - 100 - 101 example: 101 manager: description: The manager for the user. format: email type: string example: [email protected] personal_meeting_url: description: User's personal meeting url. type: string example: example.com phone_country: deprecated: true description: >- **Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead of this field. <br> User's country for Company Phone Number. type: string example: US phone_number: deprecated: true description: >- **Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead of this field. <br> User's phone number. type: string example: +1 800000000 phone_numbers: type: array items: type: object properties: code: description: >- The phone number's country code. For example, for United States phone numbers, this will be a `+1` value. type: string example: '+1' country: description: >- 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. type: string example: US label: description: |- The phone number's label: * `Mobile` * `Office` * `Home` * `Fax` enum: - Mobile - Office - Home - Fax type: string example: Mobile number: description: The user's phone number. type: string example: '800000000' verified: description: Whether Zoom has verified the phone number. type: boolean example: true pic_url: description: The URL for user's profile picture. type: string example: example.com plan_united_type: description: >- This field is returned if the user is enrolled in the [Zoom United](https://zoom.us/pricing/zoom-bundles) plan. 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. enum: - '1' - '2' - '4' - '8' - '16' - '32' - '64' - '128' - '256' - '512' - '1024' - '2048' - '4096' - '8192' - '16384' - '32768' - '65536' - '131072' type: string example: '1' pronouns: description: The user's pronouns. type: string example: '3123' pronouns_option: description: |- 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. enum: - 1 - 2 - 3 type: integer example: 1 role_id: description: >- Unique identifier of the [role](/docs/api-reference/zoom-api/methods#operation/roles) assigned to the user. type: string example: '0' status: description: Status of user's account. enum: - pending - active - inactive type: string x-enum-descriptions: - Pending User - Active User - Deactivated User example: pending vanity_url: description: Personal meeting room URL, if the user has one. type: string example: example.com verified: description: |- Displays whether user is verified or not. <br> `1` - Account verified.<br> `0` - Account not verified. type: integer example: 1 cluster: description: The user's cluster. type: string example: us04 zoom_one_type: description: >- The user's Zoom One plan option.<br>`4` - Zoom One Enterprise.<br>`8` - Zoom One Enterprise Plus.<br>`16` - Zoom One Business Plus with US/CA Unlimited.<br>`32` - Zoom One Business Plus with UK/IR Unlimited.<br>`64` - Zoom One Business Plus with AU/NZ Unlimited.<br>`128` - Zoom One Business Plus with Japan Unlimited.<br>`33554432` - Zoom One Business Plus with Global Select.<br><br>The Zoom One plan option for Gov accounts:<br>`4` - Zoom One Enterprise.<br>`8` - Zoom One Enterprise Plus.<br>`16` - Zoom One Business Plus. type: integer example: 4