Zoom Phone

Zoom Phone Users API

The Users API from Zoom Phone — 13 operation(s) for users.

GitHub OpenAPI

Operations 24

GET /phone/users List phone users #
PUT /phone/users/batch Update multiple users' properties in batch #
POST /phone/users/batch Batch add users #
GET /phone/users/{userId} Get a user's profile #
PATCH /phone/users/{userId} Update a user's profile #
POST /phone/users/{userId}/call_forward_settings/{hourType} Add user call forward setting #
DELETE /phone/users/{userId}/call_forward_settings/{hourType} Delete user call forward setting #
GET /phone/users/{userId}/call_handling/settings Get user call handling setting #
PATCH /phone/users/{userId}/call_handling/settings/{hourType} Update user call handling setting #
PUT /phone/users/{userId}/calling_plans Update user's calling plan #
POST /phone/users/{userId}/calling_plans Assign calling plan to a user #
DELETE /phone/users/{userId}/calling_plans/{planType} Unassign user's calling plan #
GET /phone/users/{userId}/outbound_caller_id/customized_numbers List users' phone numbers for a customized outbound caller ID #
POST /phone/users/{userId}/outbound_caller_id/customized_numbers Add phone numbers for users' customized outbound caller ID #
DELETE /phone/users/{userId}/outbound_caller_id/customized_numbers Remove users' customized outbound caller ID phone numbers #
GET /phone/users/{userId}/policies/{policyType} Get user policy details #
PATCH /phone/users/{userId}/policies/{policyType} Update user policy #
POST /phone/users/{userId}/profile_settings/{settingType} Add a user's profile setting #
DELETE /phone/users/{userId}/profile_settings/{settingType} Delete a user's profile profile setting #
GET /phone/users/{userId}/settings Get a user's profile settings #
PATCH /phone/users/{userId}/settings Update a user's profile settings #
POST /phone/users/{userId}/settings/{settingType} Add a user's shared access setting #
DELETE /phone/users/{userId}/settings/{settingType} Delete a user's shared access setting #
PATCH /phone/users/{userId}/settings/{settingType} Update a user's shared access setting #

Documentation

📖
Documentation
https://developers.zoom.us/docs/api/phone/
📖
APIReference
https://developers.zoom.us/docs/api/phone/
📖
Documentation
https://developers.zoom.us/docs/integrations/oauth/
📖
Documentation
https://developers.zoom.us/docs/api/phone/events/
📖
APIReference
https://developers.zoom.us/docs/api/phone/events/
📖
Documentation
https://developers.zoom.us/docs/api/number-management/
📖
APIReference
https://developers.zoom.us/docs/api/number-management/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-users-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/zoom-developer/zoom-public-workspace/documentation/uba96fr/phone

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoom-phone-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoom-phone-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Phone Users API
  description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n  To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n  All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone."
  termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html
  contact:
    name: Zoom Developers
    url: https://developer.zoom.us/
  version: '2'
servers:
- url: https://api.zoom.us/v2
tags:
- name: Users
paths:
  /phone/users:
    get:
      tags:
      - Users
      summary: List phone users
      description: "Returns a list of all of an account's users who are assigned a Zoom Phone license.\n\n**Prerequisites** \n* A Pro or higher account plan \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_users:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: listPhoneUsers
      parameters:
      - name: page_size
        in: query
        description: The number of records returned from a single API call.
        required: false
        schema:
          maximum: 100
          type: integer
          example: 30
          default: 30
      - name: next_page_token
        in: query
        description: The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
        required: false
        schema:
          type: string
          example: BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
      - name: site_id
        in: query
        description: The unique identifier of the site. Get it from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/phone/methods#operation/listPhoneSites) API.
        required: false
        schema:
          type: string
          example: 8f71O6rWT8KFUGQmJIFAdQ
      - name: calling_type
        in: query
        description: ' The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of calling plan.'
        required: false
        schema:
          type: integer
          example: 200
      - name: status
        in: query
        description: "The status of the Zoom Phone user. \n\n `pending`: The users have been assigned the Zoom Workplace license, but not been assigned Zoom Phone feature."
        required: false
        schema:
          type: string
          example: Active
          enum:
          - activate
          - deactivate
          - pending
      - name: department
        in: query
        description: The department where the user belongs.
        required: false
        schema:
          type: string
          example: Phone department
      - name: cost_center
        in: query
        description: The cost center where the user belongs.
        required: false
        schema:
          type: string
          example: Phone cost center
      - name: keyword
        in: query
        description: The partial string of user's name, extension number, or phone number.
        required: false
        schema:
          type: string
          example: test@zoom.us
      responses:
        '200':
          description: "**HTTP Status Code:** `200` **OK**  \n \nPhone users retrieved successfully."
          content:
            application/json:
              schema:
                type: object
                properties:
                  next_page_token:
                    type: string
                    description: The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
                    example: nav48KOj42vYPSG4f0cCdT575bZ980did22
                  page_size:
                    maximum: 300
                    type: integer
                    description: The number of records returned from a single API call.
                    example: 30
                    default: 30
                  total_records:
                    type: integer
                    description: The total records found for this query.
                    example: 45
                  users:
                    maxItems: 100
                    type: array
                    items:
                      type: object
                      properties:
                        calling_plans:
                          maxItems: 150
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: The name of the user's calling plan.
                                example: US/CA Metered Calling Plan
                              type:
                                type: integer
                                description: The type of calling plan where the user is enrolled.
                                example: 100
                              billing_account_id:
                                type: string
                                description: The billing account ID. It displays when the user is located in India.
                                example: 3WWAEiEjTj2IQuyDiKMd_A
                              billing_account_name:
                                type: string
                                description: The billing account name. It displays when the user is located in India.
                                example: Delhi billing
                              billing_subscription_id:
                                type: string
                                description: The billing subscription ID. It displays when the account supports billing multiple subscriptions.
                                example: FT-SUBREF-21168178
                              billing_subscription_name:
                                type: string
                                description: The billing subscription name. It displays when the account supports billing multiple subscriptions.Can be edited through the Billing page.
                                example: My Subscription
                        email:
                          type: string
                          description: The email address of the user.
                          format: email
                          example: 202007160003@testapi.com
                        extension_id:
                          type: string
                          description: The extension ID.
                          example: V4UobpuxRxCwN_8iNf7k4w
                        extension_number:
                          type: integer
                          description: The extension number assigned to the user's Zoom phone number.
                          format: int64
                          example: 1000001036
                        id:
                          type: string
                          description: The unique identifier of the user (userId).
                          example: w0RChiauQeqRlv5fgxYULQ
                        name:
                          type: string
                          description: The name of the user.
                          example: APITA AUTO
                        phone_user_id:
                          type: string
                          description: The Zoom phone identifier of the user.
                          example: BOSr0vUiTl61WLR-Q_7bUw
                        site:
                          type: object
                          properties:
                            id:
                              type: string
                              description: The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites).
                              example: IjJ2D75SQJit1VdDvkK_mQ
                            name:
                              type: string
                              description: The name of the site.
                              example: ApiTA_Site_2020_07_12_02_33_45_707
                        status:
                          type: string
                          description: "The status of the user's Zoom Phone license. The value can be either of the following:  \n \n`activate`: Active Zoom phone user.  \n \n`deactivate`: User with Zoom phone license disabled. This type of user can't make or receive calls."
                          example: activate
                        activation_status:
                          type: string
                          description: "The activation status of the user. The value can be either of the following:  \n \n`activated`: User have been activated, this type of user can make or receive calls.\n \n`ready to activate`: User have been assigned phone license but didn't activated, this type of user can make or receive calls.\n`not ready`: User have been assigned phone license, but the user didn't confirm the invitation. This user doesn't belong to this account yet."
                          example: activated
                          enum:
                          - activated
                          - ready to activate
                          - not ready
                        phone_numbers:
                          maxItems: 10
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: The phone number ID.
                                example: '---M1padRvSUtw7YihN7sA'
                              number:
                                type: string
                                description: The phone number.
                                example: '14232058798'
                        department:
                          type: string
                          description: The department where the user belongs.
                          example: Phone department
                        cost_center:
                          type: string
                          description: The cost center where the user belongs.
                          example: Phone cost center
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n The next page token is invalid or expired.\nPlease enter at least {0} valid characters. <br>\n**Error Code:** `124` <br>\n You do not have permission, because the current site `{0}` does not belong to the target sites. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:read:admin
        - phone:read:list_users:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:read:admin
        x-granular-scopes:
        - phone:read:list_users:admin
  /phone/users/batch:
    put:
      tags:
      - Users
      summary: Update multiple users' properties in batch
      description: "Updates multiple users' properties in batch. For example, you can update the users' [site](https://support.zoom.us/hc/en-us/articles/360020809672) when `batchType` is equal to `move_site`. You can update 10 users at a time. \n\n**Prerequisites:**\n* Business, or Education account\n* Zoom Phone license \n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:update:batch_users:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: updateUsersPropertiesInBatch
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                batch_type:
                  type: string
                  description: "The type that updates in batch. \n\n You must enter `move_site`: `user_ids` and `site_id` into the current request body. \n\n `assign_pending_user`: Assign user to the Zoom Phone feature of the Zoom One license. `site_id` is not required.\n `activate`: Activate Zoom Phone feature to users, `site_id` is not required."
                  example: move_site
                  enum:
                  - move_site
                  - assign_pending_user
                  - activate
                user_ids:
                  maxItems: 10
                  type: array
                  description: The IDs of user.
                  items:
                    type: string
                    example: DYHrdpjrS3uaOf7dPkkg8w
                site_id:
                  type: string
                  description: 'The unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672) where the user should be moved or assigned. '
                  example: 8f71O6rWT8KFUGQmJIFAdQ
                activation_status:
                  type: string
                  description: "The type that activates or deactivates in batch. \n\n You must enter \n\n `activate`: Activate Zoom Phone feature to users, `site_id` is not required.\n `deactivate`: Deactivate the Zoom Phone feature of users, users can not make or receive calls, `site_id` is not required."
                  example: activate
                  enum:
                  - activate
                  - deactivate
      responses:
        '204':
          description: '**HTTP Status Code:** `204` **No Content**


            Successfully update multiple users'' properties in batch.'
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n Current batch type does not support, batch type:{0}. <br>\n**Error Code:** `12007` <br>\n The user in Trash cannot be assigned Zoom One license. <br>\n**Error Code:** `12008` <br>\n The Zoom Phone feature of the Zoom One license cannot be supported for users assigned to India sites. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist. <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:update:batch_users:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:update:batch_users:admin
    post:
      tags:
      - Users
      summary: Batch add users
      description: "Adds phone users in batch. You can add up to 10 users at a time.\n\n**Prerequisites**\n* The users must be active in your [Zoom account](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#tag/Users/operation/users). \n* Pro or higher account plan with Zoom phone license\n* Account owner or admin permissions\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:batch_users:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`"
      operationId: batchAddUsers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                users:
                  maxItems: 10
                  type: array
                  items:
                    required:
                    - calling_plans
                    - email
                    - extension_number
                    type: object
                    properties:
                      email:
                        type: string
                        description: The user email. It ensures the users are active in your Zoom account.
                        example: user@example.com
                      first_name:
                        type: string
                        description: The user's first name. It ensures the users are active in your Zoom account.
                        example: Zeb
                      last_name:
                        type: string
                        description: The user's last name. It ensures the users are active in your Zoom account.
                        example: Zoomie
                      calling_plans:
                        maxItems: 150
                        type: array
                        description: "The calling plan. If the account supports billing multiple subscriptions and includes more than one type A plan, use the following format to assign a type from a specific subscription:type:billing_subscription_id or type:billing_subscription_name.   \n \n* Type &quot;AU/NZ Metered&quot; if the assigned package is &quot;Australia/New Zealand Metered Calling Plan&quot;.  \n \n* Type &quot;AU/NZ Unlimited&quot; if the assigned package is &quot;Australia/New Zealand Unlimited Calling Plan&quot;.  \n \n* Type &quot;UK/Ireland Metered&quot; if the assigned package is &quot;United Kingdom/Ireland Metered Calling Plan&quot;.  \n \n* Type &quot;UK/Ireland Unlimited&quot; if the assigned package is &quot;United Kingdom/Ireland Unlimited Calling Plan&quot;.  \n \n* Type &quot;US/CA Metered&quot; if the assigned package is &quot;United States/Canada Metered Calling Plan&quot;.  \n \n* Type &quot;US/CA Unlimited&quot; if the assigned package is &quot;United States/Canada Unlimited Calling Plan&quot;.  \n \n* Type &quot;Europe Zone A Metered&quot; if the assigned package is &quot;Europe Zone A Metered Calling Plan&quot;.  \n \n* Type &quot;Europe Zone A Unlimited&quot; if the assigned package is &quot;Europe Zone A Unlimited Calling Plan&quot;.  \n \n* Type &quot;Europe Zone B Metered&quot; if the assigned package is &quot;Europe Zone B Metered Calling Plan&quot;.  \n \n* Type &quot;Europe Zone B Unlimited&quot; if the assigned package is &quot;Europe Zone B Unlimited Calling Plan&quot;.  \n \n* Type &quot;JP Metered&quot; if the assigned package is &quot;Japan Metered Calling Plan&quot;.  \n \n* Type &quot;JP Unlimited&quot; if the assigned package is &quot;Japan Unlimited Calling Plan&quot;.  \n \n* Type &quot;IN Metered&quot; if the assigned package is &quot;India Metered Calling Plan&quot;.  \n \n* Type &quot;IN Unlimited&quot; if the assigned package is &quot;India Unlimited Calling Plan&quot;.  \n \n* Type &quot;IN Pro&quot; if the assigned package is &quot;Zoom Phone India Pro&quot;.  \n \n* Type &quot;IN International Calling Add-On&quot; if the assigned package is &quot;India International Calling Add-On&quot;.  \n \n* Type &quot;Global Select Metered&quot; if the assigned package is &quot;Global Select Metered Calling Plan&quot;.  \n \n* Type &quot;Global Select&quot; if the assigned package is &quot;Global Select Calling Plan&quot;.  \n \n* Type &quot;International Calling Add-On&quot; if the assigned package is &quot;International Calling Add-On&quot;.  \n \n* Type &quot;Beta&quot; if the assigned package is &quot;Beta Calling Plan&quot;.  \n \n* Type &quot;Pro&quot; if the assigned package is &quot;Zoom Phone Pro&quot;.  \n \n* Type &quot;Power Pack&quot; if the assigned package is &quot;Zoom Phone Power Pack&quot;.\nLeave this section blank if no package has been assigned."
                        items:
                          type: string
                          example: AU/NZ Metered or AU/NZ Metered:FT-SUBREF-21168178 or AU/NZ Metered:My SubRefer 1
                      site_code:
                        type: string
                        description: The site code. It's required if the site name is not provided or if Indian plans are assigned.
                        example: '1'
                      site_name:
                        type: string
                        description: The site name. It's required if the site code is not provided or if Indian plans are assigned.
                        example: Main Site
                      template_name:
                        type: string
                        description: The template name. Configure the user setting according to the specified template. The template must belong to the same site as the user.
                        example: account_user_template_01
                      extension_number:
                        type: string
                        description: The extension number. Do not include the site code in an extension number if the site code is enabled.
                        example: '100012345'
                      activation_status:
                        type: string
                        description: 'The activation status. Configures the activation status of user. When activation_status is not set, its value should depend on "Activate Zoom Phone users automatically" in the account settings.


                          `activate`: Activate the Zoom Phone feature, users can make or receive calls.

                          `deactivate`: Deactivate the Zoom Phone feature, users can not make or receive calls.'
                        example: activate
                        enum:
                        - activate
                        - deactivate
                      phone_numbers:
                        maxItems: 10
                        type: array
                        description: The phone numbers in E164 format. Separate multiple phone number entries with commas. Make sure that these numbers have been ported to your account as unassigned phone numbers.
                        items:
                          type: string
                          example: '+12055437350'
                      outbound_caller_id:
                        type: string
                        description: The outbound caller ID. Hides the caller ID if left blank. You can set an extension's phone number or any company number as the outbound caller ID.
                        example: '+12055437350'
                      select_outbound_caller_id:
                        type: boolean
                        description: Whether to allow this extension to change the outbound caller ID when placing calls.
                        example: true
                      sms:
                        type: boolean
                        description: Whether to enable SMS for this user.
                        example: true
                      desk_phones:
                        maxItems: 10
                        type: array
                        description: "Required: brand, model, and MAC address of each desk phone. \nOptional: provision template. Skips the provision template not supported by the device. For more information, see [supported devices](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices).\n\nEach user can be assigned up to 3 desk phones.\n\nAll users must belong to the same site if a desk phone is assigned to multiple users."
                        items:
                          type: object
                          properties:
                            brand:
                              type: string
                              description: The manufacturer (brand) name of the device.
                              example: Yealink
                            model:
                              type: string
                              description: The model name of the device.
                              example: 405hd
                            mac:
                              type: string
                              description: The MAC address of the desk phone.
                              example: 80-5e-c0-3d-eb-c4
                            provision_template:
                              type: string
                              description: The provision template name. Supported by select devices.
                              example: TestProvisionTemplate
      responses:
        '201':
          description: "**HTTP Status Code:** `201`   \n \nCreated."
          content:
            application/json:
              schema:
                maxItems: 10
                type: array
                items:
                  type: object
                  properties:
                    email:
                      type: string
                      description: The imported user email.
                      example: ta_test_import_user_01@example.com
                    id:
                      type: string
                      description: The user ID.
                      example: FwOAeL4TRmqQrmF0jOfzkQ
        '400':
          description: "**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n User size must be less than 10.\nYou need to have administrative privileges to edit this site. <br>\n**Error Code:** `300` <br>\n Validation Failed. <br>\n"
        '404':
          description: "**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `404` <br>\n Template is invalid <br>\n"
        '429':
          description: "**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "
      security:
      - openapi_oauth:
        - phone:write:admin
        - phone:write:batch_users:admin
        openapi_authorization: []
      x-extensions:
        x-permissions: []
        x-macro-scopes:
        - phone:write:admin
        x-granular-scopes:
        - phone:write:batch_users:admin
  /phone/users/{userId}:
    get:
      tags:
      - Users
      summary: Get a user's profile
      description: "Returns a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites**\n * A Business or Enterprise account \n* A Zoom Phone license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read`,`phone:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:user`,`phone:read:user:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`"
      operationId: phoneUser
      parameters:
      - name: userId
        in: path
        description: The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
        required: true
        schema:
          type: string
          example: DYHrdpjrS3uaOf7dPkkg8w
      responses:
        '200':
          description: "**HTTP Status Code:** `200`   \n User profile object returned. "
          content:
            application/json:
              schema:
                type: object
                properties:
                  calling_plans:
                    maxItems: 150
                    type: array
                    description: The calling plan of the user
                    items:
                      type: object
                      properties:
                        type:
                          type: integer
                          description: 'The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of calling plan. '
                          example: 600
                        billing_account_id:
                          type: string
                          description: The billing account ID. It displays when the user is located in India.
                          example: 3WWAEiEjTj2IQuyDiKMd_A
                        billing_account_name:
                          type: string
                          description: The billing account name. It displays when the user is located in India.
                          example: Delhi billing
                        billing_subscription_id:
                          type: string
                          description: The billing subscription ID. It displays when the account supports billing multiple subscriptions.
                          example: FT-SUBREF-21168178
                        billing_subscription_name:
                          type: string
                          description: The billing subscription name. It displays when the account supports billing multiple subscriptions.Can be edited via the Billing page.
                          example: My Subscription
                  cost_center:
                    type: string
                    description: The cost center name.
                    example: testCostCenter
                  department:
                    type: string
                    description: The department's name.
                    example: testDepartment
                  email:
                    type: string
                    description: The email address of the user.
                    example: suesu_test_delete3@testapi.com
                  emergency_address:
                    type: object
                    properties:
                      address_line1:
                        type: string
                        description: The address Line 1 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the house number and street name.
                        example: 55 Almaden Boulevard
                      address_line2:
                        type: string
                        description: The address Line 2 of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address) that contains the building number, floor number, unit, and others.
                        example: 1002 Airport Way S
                      city:
                        type: string
                        description: The city of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: SAN JOSE
                      country:
                        maxLength: 2
                        minLength: 2
                        type: string
                        description: The two-lettered country code (Alpha-2 code in ISO-3166 format) standard of the site's [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: US
                      id:
                        type: string
                        description: The emergency address ID.
                        example: CCc8zYT1SN60i7uDMzDbXA
                      state_code:
                        type: string
                        description: The state code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: CA
                      zip:
                        type: string
                        description: The zip code of the [emergency address](https://support.zoom.us/hc/en-us/articles/360021062871-Setting-an-Emergency-Address).
                        example: '95113'
                  extension_id:
                    type: string
        

# --- truncated at 32 KB (369 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoom-phone/refs/heads/main/openapi/zoom-phone-users-api-openapi.yml