Returns the specified absence region.

GET

https://api.awork.com/api/v1/absenceregions/:absenceRegionId

GET

/api/v1/absenceregions/:absenceRegionId

curl https://api.awork.com/api/v1/absenceregions/absenceRegionId \
     -H "Authorization: Bearer <token>"

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2022-03-11T15:33:47.100Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2022-03-11T21:15:00.100Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Hamburg",
  "countryCode": "DE",
  "country": "Germany",
  "locationCode": "DE-HH",
  "location": "Hamburg",
  "isDefault": true,
  "numberOfPublicHolidays": 10,
  "assignedUsers": [
    "7b356284-d22b-4f74-980d-0a548d3b6318",
    "b37f07dd-6644-4271-9c8a-bb700cc21b63"
  ],
  "publicHolidays": [
    {
      "date": "2024-12-25T00:00:00Z",
      "name": "Christmas Day",
      "localName": "Erster Weihnachtstag"
    }
  ]
}

Returns the absence region with public holiday details for its country and location.

Required Permissions

The user must be an admin or have user-planning-data:write permission to see users assigned to the absence region.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

absenceRegionIdstringRequiredformat: "uuid"

The id of the absence region.

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

namestring or nullOptional

The name of the absence region, as specified by the user. It must be unique within the workspace.

countryCodestring or nullOptional

The country code of the absence region. It must be a valid ISO 3166-1 alpha-2 country code.

countrystring or nullOptional

The english name of the country.

locationCodestring or nullOptional

The location code of the absence region. It should be a valid ISO 3166-2 country subdivision code.

locationstring or nullOptional

The name of the location. It will always be in the related country's language.

isDefaultbooleanOptional

Indicates whether the absence region is the default absence region. Any new user will be assigned to the default absence region.

numberOfPublicHolidaysintegerOptional

The number of public holidays in the absence region.

assignedUserslist of strings or nullOptional

The list of user ids assigned to the absence region.

publicHolidayslist of objects or nullOptional

The list of public holidays in the absence region.

Errors

404

Not Found Error