GET /organizations/{organizationId}
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Provide id of organization 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": "987abc78-39c5-436f-a70b-d3a14db753c0",
"validFrom" :"2022-01-01T00:00:00+00:00",
"validTo":"2022-12-31T23:59:59+00:00",
"name": {
"organizationName": "Organization Name",
"description": "Description of organization"
},
"organizationType": {
"type": "project",
"parentOrganizationUnitId": "123abc78-39c5-436f-a70b-d3a14db753c6"
},
"address": {
"relId": "123456",
"id": "321abc78-39c5-436f-a70b-d3a14db753c6",
"street": "",
"city": "",
"state": "",
"postalCode": "",
"country": "DE"
},
"contactInformation": {
"organizationEmail": "[email protected]",
"phoneNumber":"+49123456789"
},
"assignUsers": {
"administrators": [
{
"userId": "c4206912-62a6-4ca6-af24-f95d99624615"
}],
"approvers": [
{
"userId": "91de12c1-4237-431f-a408-e4f7013434b4"
}],
"employees": [
{
"userId": "993ea1fb-ae4a-422e-9e90-5ecdbb1afb7f"
}]
},
"timeTrackingSettings": {
"maxTimeEntryLength":"",
"allowTimeEntriesFromTime": "",
"allowTimeEntriesToTime": "",
"minTimeEntryBreakLength": "",
"maxTimeEntryBreakLength": "",
"roundingTypeTimeEntryStartTime": "off",
"roundingAmountTimeEntryStartTime": "",
"roundingTypeTimeEntryEndTime": "off",
"roundingAmountTimeEntryEndTime": "",
"roundingTypeBreakStartTime": "off",
"roundingAmountBreakStartTime": "",
"roundingTypeBreakEndTime": "off",
"roundingAmountBreakEndTime":"",
"allowTimeEntriesInPast": "true",
"allowTimeEntriesInFuture": "true",
"onlyClockTimeEntriesAllowed": "false",
"automaticTargetTimes": "false",
"ignoreTargetTimes": "true"
},
"locationTracking": {
"isOn": "true",
"locationRadius": "100",
"latitude": 123.456,
"longitude": 987.654,
"clockingMacAddress": "",
"clockingSsId": ""
},
"exportIds": {
"exportId1": "123",
"exportId2": "456",
"exportId3": "789",
"hardwareTerminalChipId": "chip 123"
}
}