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: contact_center_user:read:admin
Rate Limit Label: MEDIUM
Request Params
| 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":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","users":[{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","user_email":"\u003cemail\u003e","role_id":"\u003cstring\u003e","role_name":"\u003cstring\u003e","client_integration":"Default","status_id":"\u003cstring\u003e","status_name":"Offline","sub_status_id":"\u003cstring\u003e","sub_status_name":"Meal","user_access":"inactive","modified_by":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e","country_iso_code":"\u003cstring\u003e","region_id":"\u003cstring\u003e","region_name":"\u003cstring\u003e","channel_settings":{"multi_channel_engagements":{"enable":"\u003cboolean\u003e","max_agent_load":"\u003cinteger\u003e"},"concurrent_message_capacity":"\u003cinteger\u003e"}},{"user_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","user_email":"\u003cemail\u003e","role_id":"\u003cstring\u003e","role_name":"\u003cstring\u003e","client_integration":"Microsoft_Dynamics_365","status_id":"\u003cstring\u003e","status_name":"Occupied","sub_status_id":"\u003cstring\u003e","sub_status_name":"Meal","user_access":"active","modified_by":"\u003cstring\u003e","last_modified_time":"\u003cdateTime\u003e","country_iso_code":"\u003cstring\u003e","region_id":"\u003cstring\u003e","region_name":"\u003cstring\u003e","channel_settings":{"multi_channel_engagements":{"enable":"\u003cboolean\u003e","max_agent_load":"\u003cinteger\u003e"},"concurrent_message_capacity":"\u003cinteger\u003e"}}]}