API v1 ReferenceAbsence Regions

Gets all absence regions.

<Check title="Required Permissions" icon="key">The user must be admin or have `user-planning-data:write` permissions to see the users assigned to the absence regions.</Check>

Authentication

AuthorizationBearer

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

Response

OK
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.