From Bright Pattern Documentation
Jump to: navigation, search
• 5.2

<translate>= Get User Data= Returns user data, such as name, team, extension, skills, and so forth.

Request

URL

http[s]://<host>/configapi/v2/user/<login_id>

HTTP Method

GET

Content-Type

application/json

Parameters

Parameter Data-Type Description Example
loginId string The username of the user that you want to get data for "sheila.thomas"

Request Body

Empty. All you need is the username in the URL and the content-type header.


Response

In response to a successful request, the user data is displayed in JSON. You can verify user data by checking the same user information in Contact Center Administrator > Users & Teams > Users.

Failed requests result in an error code, and no user data is shown.

Example Response

 {
 "loginId" : "sheila.thomas",
 "firstName" : "Sheila",
 "lastName" : "Thomas",
 "team" : "Customer Service",
 "email": "sheila.thomas@yourcompany.com",
 "extension": "2072",
 "workPhone": "123456",
 "mobilePhone": "78910",
 "disabled": false,
 "changePassword": true,
 "skills": {
   "Customer Service": 100,
   "English": 33
 },
 "roles": ["Agent"]
 }



</translate>

< Previous | Next >