absenceRegions

Returns the specified absence region.

Changed on

Returns the absence region with public holiday details for its country and location. <Check title="Required Permissions" icon="key">The user must be an admin or have user-planning-data:write permission to see users assigned to the absence region.</Check>

get/absenceregions/{absenceRegionId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/absenceregions/{absenceRegionId}
  • Auth: HTTP bearer

Path parameters

absenceRegionIdstring uuid required

The id of the absence region.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

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

countryCodestring nullable

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

countrystring nullable

The english name of the country.

locationCodestring nullable

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

locationstring nullable

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

isDefaultboolean

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

numberOfPublicHolidaysinteger

The number of public holidays in the absence region.

assignedUsersstring[] nullable

The list of user ids assigned to the absence region.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetAbsenceRegionById removed and replaced with absenceRegions_GetAbsenceRegionById