5.2:User-management-api-specification/GetUserData

• 5.2

Get User Data

Returns user data, such as name, team, extension, skills, and login information.

Request

URL

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

For example:

http://example.com/configapi/v2/user/frank.zappa

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	"frank.zappa"

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.

For failed requests, no user data is shown.

Example Response

 {
 "disabled":false,
 "changePassword":false,
 "skills":{},
 "loginId":"frank.zappa",
 "firstName":"Frank",
 "lastName":"Zappa",
 "team":"Customer Service",
 "extension":"1048",
 "email":"frank.zappa@gmail.com",
 "roles":["Agent"]
 "loginInfo": {
    "isLoggedIn": true,
    "lastLogin": "2024-01-11T20:39:16.000Z",
    "lastLogout": "2024-01-11T20:39:16.000Z",
    "browser": "Chrome 120.0.0",
    "phoneMode": "Browser Secure",
    "os": "Linux",
    "ipAddress": "172.27.0.1",
    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
    "adHelperVersion": "5.20.0.604",
    "appType": "Agent Desktop",
    "appVersion": "5.24.99.755"
  }
 }

Response Parameters

Parameter	Data-Type	Description	Example
disabled	Boolean	Whether the user is disabled ("true") or not ("false")	false
changePassword	Boolean	Whether the user must change password ("true") on next login or not ("false")	false
skills	array	The user's skills	{["English", "Spanish"]}
loginId	string	The username of the user	"frank.zappa"
firstName	string	The first name of the user	"Frank"
lastName	string	The last name of the user	"Zappa"
team	string	The name of the team assigned to the user	"Customer Service"
extension	number	The phone extension number of the user	"1048"
email	string	The email address of the user	"frank.zappa@gmail.com"
roles	array	The role assigned to the user	["Agent", "Supervisor"]
isLoggedIn	Boolean	Whether the user is logged in ("true") or not ("false")	true
lastLogin	Timestamp	Time that the user last logged in, in year-month-day-time format	2024-01-11T20:39:16.000Z
lastLogout	Timestamp	Time that the user last logged out, in year-month-day-time format	2024-01-11T20:39:16.000Z
browser	string	Type and version of the user's browser	Chrome 120.0.0
phoneMode	string	operational mode/configuration settings of phone application or device	Browser Secure
os	string	The user's operating system	Linux
ipAdress	number	The user's Internet Protocol address	172.27.0.1
userAgent	string	Web browser and operating system of the user's device	Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36
adHelperVersion	number	Agent Desktop Helper version	5.20.0.604
appType	string	App that the user is logged in on	Agent Desktop
appVersion	number	Version of the app that the user is logged in on	5.24.99.755

< Previous | Next >