Zoom Phone

Zoom Phone Users API

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

GitHub OpenAPI

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /phone/users List users who have a Zoom Phone license · List phone users #
Ask an LLM
“Which people in my account have a Zoom Phone license assigned?”
“Can I filter the list of phone users by site, department or cost center?”
Tell an agent
List every phone-licensed user in my account.
List phone users at site {site_id} in department {department}.
PUT /phone/users/batch Move or activate several phone users at once · Update multiple users' properties in batch #
Ask an LLM
“Can I move up to ten phone users to a different site in one request?”
“Is there a bulk way to activate or deactivate the phone feature for a group of users?”
Tell an agent
Move users {user_ids} to site {site_id} in one batch.
Run a {batch_type} batch update with activation status {activation_status} for users {user_ids}.
POST /phone/users/batch Add up to ten phone users in one batch · Batch add users #
Ask an LLM
“Can I onboard several existing Zoom users onto the phone system at the same time?”
“What is the maximum number of users I can add as phone users in a single batch call?”
Tell an agent
Add these users to Zoom Phone in one batch: {users}.
Bulk-enroll the new hires {users} as phone users.
GET /phone/users/{userId} Get a user's Zoom Phone profile · Get a user's profile #
Ask an LLM
“Where can I see a user's phone profile, like their extension, site and calling plan?”
“What phone number and extension does a particular user have in Zoom Phone?”
Tell an agent
Show the Zoom Phone profile for user {userId}.
Look up the extension and phone numbers assigned to {userId}.
PATCH /phone/users/{userId} Update a user's phone profile · Update a user's profile #
Ask an LLM
“Can I change a user's phone extension number or move them to another site?”
“Is it possible to set a different emergency address or template on a user's phone profile?”
Tell an agent
Change the extension number of user {userId} to {extension_number}.
Move user {userId} to site {site_id} on their phone profile.
POST /phone/users/{userId}/call_forward_settings/{hourType} Add call forwarding numbers for a user · Add user call forward setting #
Ask an LLM
“Can I forward a user's incoming calls to an external number during closed hours?”
“How do I add forwarding destinations for a user under a specific hour type?”
Tell an agent
Add call forwarding numbers for user {userId} during {hourType}.
Forward {userId}'s calls during holiday {holiday_hour_id} to these numbers: {call_forward_settings}.
DELETE /phone/users/{userId}/call_forward_settings/{hourType} Remove call forwarding numbers from a user · Delete user call forward setting #
Ask an LLM
“Can I stop a user's calls from forwarding to an external number for a given hour type?”
“What's the way to delete one specific forwarding destination from a user?”
Tell an agent destructive · confirm first
Remove the call forwarding numbers for user {userId} during {hourType}.
Delete forwarding entry {call_forward_id} from user {userId}'s {hourType} forwarding.
GET /phone/users/{userId}/call_handling/settings Get a user's call handling setting · Get user call handling setting #
Ask an LLM
“How are a user's incoming calls routed during business hours versus closed hours?”
“Can I check what call handling a user has configured for a particular holiday?”
Tell an agent
Show the call handling setting for user {userId} for {hour_type}.
Get user {userId}'s call routing for holiday {holiday_hour_id}.
PATCH /phone/users/{userId}/call_handling/settings/{hourType} Update a user's call handling for an hour type · Update user call handling setting #
Ask an LLM
“Can I change how a user's calls ring and route during their closed hours?”
“Is it possible to edit a user's call distribution or forwarding for a break period?”
Tell an agent
Update the {hourType} call handling for user {userId}.
Set user {userId}'s {hourType} call distribution to {call_distribution_setting}.
PUT /phone/users/{userId}/calling_plans Switch a user's calling plan · Update user's calling plan #
Ask an LLM
“Can I swap a user from one calling plan type to another without unassigning first?”
“What do I need to provide to switch a user's calling plan when there are several billing subscriptions?”
Tell an agent
Switch user {userId} from calling plan {source_type} to {target_type}.
Change {userId}'s plan from {source_type} to {target_type} using subscription {target_billing_subscription_id}.
POST /phone/users/{userId}/calling_plans Assign a calling plan to a user · Assign calling plan to a user #
Ask an LLM
“How do I give a phone user a calling plan so they can make outside calls?”
“Can I assign more than one calling plan to the same user?”
Tell an agent
Assign calling plans {calling_plans} to user {userId}.
Give user {userId} a new calling plan.
DELETE /phone/users/{userId}/calling_plans/{planType} Remove a calling plan from a user · Unassign user's calling plan #
Ask an LLM
“Can I take a calling plan away from a user who no longer needs it?”
“Which billing account do I specify when unassigning a user's calling plan?”
Tell an agent destructive · confirm first
Unassign calling plan {planType} from user {userId}.
Remove plan {planType} from {userId} under billing account {billing_account_id}.
GET /phone/users/{userId}/outbound_caller_id/customized_numbers List numbers a user can use as custom caller ID · List users' phone numbers for a customized outbound caller ID #
Ask an LLM
“Which phone numbers can a user pick as their customized outbound caller ID?”
“Can I see only the caller ID numbers already selected for a user?”
Tell an agent
List the numbers available as customized outbound caller ID for user {userId}.
Show caller ID numbers for {userId} with selected set to {selected}.
POST /phone/users/{userId}/outbound_caller_id/customized_numbers Add custom outbound caller ID numbers for a user · Add phone numbers for users' customized outbound caller ID #
Ask an LLM
“Can I let a user show a different company number when they place outbound calls?”
“What's needed to add numbers to a user's customized caller ID list?”
Tell an agent
Add phone numbers {phone_number_ids} to user {userId}'s customized outbound caller ID.
Let user {userId} display number {phone_number_ids} as caller ID.
DELETE /phone/users/{userId}/outbound_caller_id/customized_numbers Remove custom outbound caller ID numbers from a user · Remove users' customized outbound caller ID phone numbers #
Ask an LLM
“Can I stop a user from using a particular number as their outbound caller ID?”
“Is there a way to clear numbers from a user's customized caller ID list?”
Tell an agent destructive · confirm first
Remove customized caller ID entries {customize_ids} from user {userId}.
Clear the customized outbound caller ID numbers for {userId}.
GET /phone/users/{userId}/policies/{policyType} Get a user's phone policy details · Get user policy details #
Ask an LLM
“Is a specific user allowed to make emergency calls under their phone policy?”
“Where can I read the details of one policy type applied to a user?”
Tell an agent
Show the {policyType} policy for user {userId}.
Check user {userId}'s allow_emergency_calls policy.
PATCH /phone/users/{userId}/policies/{policyType} Update a user's phone policy · Update user policy #
Ask an LLM
“Can I change a single policy type for one user without touching the rest?”
“Is it possible to adjust whether a user can place emergency calls?”
Tell an agent
Update the {policyType} policy for user {userId}.
Change user {userId}'s emergency calls policy setting.
POST /phone/users/{userId}/profile_settings/{settingType} Add holiday or break hours to a user · Add a user's profile setting #
Ask an LLM
“Can I add holiday hours to a user's phone schedule?”
“Is there a way to create break hours for an individual phone user?”
Tell an agent
Add {settingType} to user {userId}'s phone schedule.
Create a break hours entry for user {userId}.
DELETE /phone/users/{userId}/profile_settings/{settingType} Delete a user's holiday or break hours · Delete a user's profile profile setting #
Ask an LLM
“Can I remove a holiday from a user's phone schedule?”
“What do I pass to delete one specific break period from a user?”
Tell an agent destructive · confirm first
Delete holiday {holiday_hour_id} from user {userId}'s {settingType}.
Remove break period {break_hour_id} from user {userId}'s {settingType}.
GET /phone/users/{userId}/settings Get a user's phone profile settings · Get a user's profile settings #
Ask an LLM
“What area code, caller ID and business hours does a user have set in their phone settings?”
“Can I view a user's voicemail, delegation and shared line settings in one place?”
Tell an agent
Show the phone profile settings for user {userId}.
Get the business hours and outbound caller ID settings of {userId}.
PATCH /phone/users/{userId}/settings Update a user's phone profile settings · Update a user's profile settings #
Ask an LLM
“Can I change a user's audio prompt language or music on hold?”
“Is it possible to set a user's business hours and outbound caller ID in one update?”
Tell an agent
Set user {userId}'s outbound caller ID to {outbound_caller_id}.
Change the area code for {userId} to {area_code}.
POST /phone/users/{userId}/settings/{settingType} Add delegation, intercom or shared access for a user · Add a user's shared access setting #
Ask an LLM
“Can I give an assistant delegation access to a user's phone line?”
“Is there a way to share a user's voicemail or call recordings with other members?”
Tell an agent
Add delegation assistant {delegation_assistant_extension_id} to user {userId}.
Grant {voicemail_access_members} shared access to user {userId}'s voicemail.
DELETE /phone/users/{userId}/settings/{settingType} Remove delegation, intercom or shared access from a user · Delete a user's shared access setting #
Ask an LLM
“Can I revoke someone's shared access to a user's voicemail?”
“Is it possible to remove a delegation assistant or intercom contact from a user?”
Tell an agent destructive · confirm first
Remove shared access {shared_id} from user {userId}'s {settingType} setting.
Remove delegation assistant {assistant_extension_id} from user {userId}'s {settingType}.
PATCH /phone/users/{userId}/settings/{settingType} Update delegation, intercom or shared access for a user · Update a user's shared access setting #
Ask an LLM
“Can I change who already has shared access to a user's automatic call recordings?”
“Is it possible to edit an existing intercom or delegation setting on a user?”
Tell an agent
Update the {settingType} shared access setting for user {userId}.
Change the existing auto call recording access members of {userId} to {auto_call_recording_access_members}.

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: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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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.


    To learn how to get your credentials and create private or public applications, see Zoom APIs use OAuth 2.0 authorization.


    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:


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