Zoom Public API Documentation
List users' profiles
GET {{baseUrl}}/contact_center/users?search_key=<string>&next_page_token=<string>&page_size=30®ion_id=<string>&user_access=inactive
Returns a list of users and their information. Scopes: Rate Limit Label: contact_center_user:read:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
search_key
|
string | The user's email address or username. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
region_id
|
string | The region's ID. | |
user_access
|
string | The user's access status. * `active` — The user's role permissions allow them to access the Contact Center. * `inactive` — The user cannot access the Contact Center. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"users": [
{
"user_id": "<string>",
"display_name": "<string>",
"user_email": "<email>",
"role_id": "<string>",
"role_name": "<string>",
"client_integration": "Default",
"status_id": "<string>",
"status_name": "Offline",
"sub_status_id": "<string>",
"sub_status_name": "Meal",
"user_access": "inactive",
"modified_by": "<string>",
"last_modified_time": "<dateTime>",
"country_iso_code": "<string>",
"region_id": "<string>",
"region_name": "<string>",
"channel_settings": {
"multi_channel_engagements": {
"enable": "<boolean>",
"max_agent_load": "<integer>"
},
"concurrent_message_capacity": "<integer>"
}
},
{
"user_id": "<string>",
"display_name": "<string>",
"user_email": "<email>",
"role_id": "<string>",
"role_name": "<string>",
"client_integration": "Microsoft_Dynamics_365",
"status_id": "<string>",
"status_name": "Occupied",
"sub_status_id": "<string>",
"sub_status_name": "Meal",
"user_access": "active",
"modified_by": "<string>",
"last_modified_time": "<dateTime>",
"country_iso_code": "<string>",
"region_id": "<string>",
"region_name": "<string>",
"channel_settings": {
"multi_channel_engagements": {
"enable": "<boolean>",
"max_agent_load": "<integer>"
},
"concurrent_message_capacity": "<integer>"
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/users?search_key=<string>&next_page_token=<string>&page_size=30®ion_id=<string>&user_access=inactive?search_key=<string>&next_page_token=<string>&page_size=30®ion_id=<string>&user_access=inactive' -H 'Accept: application/json'
ENDPOINTS