Get Users¶
Endpoint URL¶
(see more)
[GET] https://[address]:[port]/rest/ExternalGetUsers
Calling The Endpoint¶
There is one optional parameter you need to specify:
- Parameters
Fields
- note this field is optional, when passed it is handled as a CSV separated by ,
- Headers
x-api-key
- This is the API key from the WCF Connector in Totalview Admin (see more)
Finding The Custom Field Name¶
Open Totalview Admin
Navigate to the custom fields view
Click on any of the custom fields
The
Custom Field
name is the first field called Name
Note: Only custom fields marked as
Visible in client
will be usableExample Calling The Endpoint Via cURL¶
curl --location --request GET 'https://[address]:[port]/rest/ExternalGetUsers?fields=Deildir' \
--header 'x-api-key: APIKEY' \
--data-raw ''
Example result
{
"ExternalGetUsersResult": [
{
"CustomFields": [
{
"Caption": "Deildir",
"UseAsDivision": true,
"Values": [
"ADMIN"
]
}
],
"FirstName": "Tina",
"FullName": "Tina White",
"LastName": "White",
"LocalNumber": "+298344000",
"MobileNumber": "+298344000",
"UserID": "TW"
}
]
}