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

KeyDatatypeRequiredDescription
next_page_tokenstringUse 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_sizenumberThe number of items returned per page.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:30,&quot;total_records&quot;:&quot;\u003cinteger\u003e&quot;,&quot;roles&quot;:[{&quot;role_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;role_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;role_description&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_users&quot;:&quot;\u003cinteger\u003e&quot;,&quot;modified_by&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;},{&quot;role_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;role_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;role_description&quot;:&quot;\u003cstring\u003e&quot;,&quot;total_users&quot;:&quot;\u003cinteger\u003e&quot;,&quot;modified_by&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_modified_time&quot;:&quot;\u003cdateTime\u003e&quot;}]}