Logo
Zoom Public API Documentation

List roles

GET {{baseUrl}}/contact_center/roles?next_page_token=<string>&page_size=30

Use this API to return a list of roles.

Scopes: contact_center_role:read:admin

Rate Limit Label: Medium

 

Body PARAM

Key Datatype Required Description 
next_page_token
string Use the next page token to paginate through large result sets. A next page token returns 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.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_size": 30, "total_records": "<integer>", "roles": [ { "role_id": "<string>", "role_name": "<string>", "role_description": "<string>", "total_users": "<integer>", "modified_by": "<string>", "last_modified_time": "<dateTime>" }, { "role_id": "<string>", "role_name": "<string>", "role_description": "<string>", "total_users": "<integer>", "modified_by": "<string>", "last_modified_time": "<dateTime>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/roles?next_page_token=<string>&page_size=30?next_page_token=<string>&page_size=30' -H 'Accept: application/json'

ENDPOINTS