GET /users/{userId}
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Provide id of user which should be retrieved. If id is provided which authenticated user is not allowed to see, then 401 code will be returned. |
Responses
| Code | Title | Description |
|---|---|---|
| 200 | Success | Returned if request was successful. |
| 400 | Bad Request | Returned if request was bad or any other error occured. |
| 401 | Unauthorized | Returned if request was not authorized (eg. due to bad API key). |
| 404 | Not Found | Returned if request could not be found. |
Response JSON example:
{
"id": "123abc45-39c5-436f-a70b-d3a14db753c6",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"validFrom" :"2022-01-01T00:00:00+00:00",
"validTo":"2022-12-31T23:59:59+00:00",
"gender": "none",
"mobilePhoneNumber": "+43123123",
"nationality": "DE",
"birthDate" : "1985-04-25",
"availableLoginMethods": [
0,
1
],
"address": {
"id": "321abc78-39c5-436f-a70b-d3a14db753c6",
"street": "",
"city": "",
"state": "",
"postalCode": "",
"country": "DE"
},
"exportIds": {
"exportId1": "",
"exportId2": "",
"exportId3": "",
"hardwareTerminalChipId": ""
},
"roles": [
{
"role": "approver",
"organizations": [
{
"name": "Name of organization" OR "id": "123abc45-39c5-436f-a70b-123456789012"
},
{
"name": "Name of organization" OR "id": "321abc45-39c5-436f-a70b-123456789012"
}]
},
{
"role": "employee",
"organizations": [
{
"name": "Name of organization" OR "id": "987abc45-39c5-436f-a70b-123456789012"
},
{
"name": "Name of organization" OR "id": "456abc45-39c5-436f-a70b-123456789012"
}]
}
],
"userEmployments": [
{
"id": "123abc45-39c5-436f-abab-d3a14db753c6",
"basicData": {
"employmentStart": "2022-01-15T00:00:00+00:00",
"employmentEnd": "",
"comment": "Test comment which will be sent to Payroll Accountant",
"employeeId": "123",
"employmentId": "321",
"employmentRelationship": "worker",
"dismissReason": "mutual_notice",
"openVacationDays": "231.1",
"outstandingHours": "123.3"
},
"paySchedules": [
{
"id": "12345678-215a-4023-a759-f125a6202b93"
},
{
"id": "87654321-8849-4b0d-b8ed-1fc1d5fc08aa"
}
],
"insuranceInformation": {
"healthInsuranceCountry": "DE",
"healthInsuranceNumber": "123",
"tariffGroup": "321",
"typeOfHealthInsurance": "private",
"healthInsuranceCompany": "Insurance Corp."
},
"employmentContract": {
"position": "Manager",
"employmentType": "full_time",
"weeklyHours": "35",
"probationPeriod": "2022-02-15T00:00:00+00:00",
"periodOfNotice": "2 Weeks"
},
"collectiveAgreement": {
"collectiveAgreementId": "123",
"collectiveAgreementName": "Workers Agreement",
"usageGroup": "123ABC"
},
"publicProfile": {
"office": "Main Office",
"department": "HR Department",
"costCenter": "987ABC",
"workPhone": "+49123"
},
"hrInformation": {
"status": "active",
"superVisorUserId": "87654321-abcd-4b0d-b8ed-1fc1d5fc08aa",
"hrContactUserId": "87654321-efgh-4b0d-b8ed-1fc1d5fc08aa"
},
"payrollInformation": {
"taxIdentificationNumber": "number",
"taxOfficeId": "1111",
"taxClass": "1",
"localAuthorityId": "222",
"workplaceId": "123",
"wageTaxAllowance": "1.2",
"maritalStatus": "married",
"denomination": "denomination",
"childBenefit": "5.1",
"dependants": "0",
"childRelief": "10.1",
"severeDisability": "true",
"disability": "disability",
"highestGraduation": "graduation",
"highestOccupation": "occupation",
"buak": "false",
"occasionallyEmployed": "false",
"employmentBenefits": "false",
"commuterAllowance": "23",
"subwayTax": "true",
"municipalTax": "false"
},
"overtimeSettings": {
"timeCompensationAmount": "123.32"
},
"vacationSettings": {
"vacationCompensationAmount": "3.12"
},
"bankDetails": {
"paymentType": "bank_transfer",
"nameOfAccountHolder": "John Doe",
"iban": "DE1234567890",
"bicSwift": "XXXYYY",
"bankName": "Bank of America"
}
}
]
}