Retrieves an entity based on the provided key
| Header | Name | Description | Type | Additional information |
|---|---|---|---|---|
| Accept | Mime Type |
The accept header used to specify the acceptable response mime type |
string |
Optional |
| Authorization | Scheme |
The authorization method (should always be Basic) |
string |
Required |
| Security Token |
The security token obtained by successfully authenticating a user with the Account API |
globally unique identifier |
Required |
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
The key of the entity to retrieve |
string |
Required |
None.
{
"IsBetaTester": true,
"UserId": "sample string 2",
"CorpID": 1,
"Password": "sample string 3",
"LastName": "sample string 4",
"FirstName": "sample string 5",
"UserType": 1,
"CreatedBy": "sample string 6",
"Position": "sample string 7",
"EditFlag": true,
"SuperUserFlag": true,
"TrainerFlag": true,
"OfficePhone": "sample string 11",
"MobilePhone": "sample string 12",
"Pager": "sample string 13",
"HomePhone": "sample string 14",
"Email": "sample string 15",
"Fax": "sample string 16",
"ReliefUserID": "sample string 17",
"HomeAddress": "sample string 18",
"HomeCity": "sample string 19",
"HomeState": "sample string 20",
"HomeZip": "sample string 21",
"OfficeAddress": "sample string 22",
"OfficeCity": "sample string 23",
"OfficeState": "sample string 24",
"OfficeZip": "sample string 25",
"Notes": "sample string 26",
"StartDate": "2024-11-13T23:33:44.5793966",
"EndDate": "2024-11-13T23:33:44.5793966",
"PrimaryRAS": "sample string 27",
"SecondaryRAS": "sample string 28",
"Primary800Number": "sample string 29",
"UserMap": "QEA=",
"UserTree": "QEA=",
"UserTreev3": "QEA=",
"UserProfile": "QEA=",
"Stamp": "2024-11-13T23:33:44.5793966",
"LastRefresh": "2024-11-13T23:33:44.5793966",
"HomeTerminalID": 1,
"PDADeviceID": 1,
"ModemTypeID": 1,
"TrainedByID": "sample string 30",
"IVRUserID": "sample string 31",
"IVRPassCode": "sample string 32",
"CSNTgroup": 1,
"CSNTacctinfo": "sample string 33",
"PasswordExpirationDate": "2024-11-13T23:33:44.5793966"
}
An error response containing the details about a failed api request
{
"error": {
"batcherror": {
"operationindex": 1,
"requestindex": 2
},
"code": "UnknownError",
"innererror": {
"innererror": {
"message": {
"lang": "en-US",
"value": "sample string 3"
},
"type": "sample string 5",
"trace": "sample string 4"
},
"message": {
"lang": "en-US",
"value": "sample string 6"
},
"type": "sample string 8",
"trace": "sample string 7"
},
"message": {
"lang": "en-US",
"value": "sample string 9"
}
}
}