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
Request Params
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":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","roles":[{"role_id":"\u003cstring\u003e","role_name":"\u003cstring\u003e","role_description":"\u003cstring\u003e","total_users":"\u003cinteger\u003e","modified_by":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"},{"role_id":"\u003cstring\u003e","role_name":"\u003cstring\u003e","role_description":"\u003cstring\u003e","total_users":"\u003cinteger\u003e","modified_by":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e"}]}