API v1 ReferenceAbsence Regions

Gets all the absence regions.

Gets all the absence regions of the workspace. Depending on the user's permissions, the visibility of users assigned to the regions may vary. Admin will see all users assigned to all regions. Planner users with User Team Filter on (UserTeamsData) will only see same team users assigned to the regions. Any other user will only see themselves assigned to the regions. <Check title="Required Permissions">Any authenticated user.</Check>

Headers

AuthorizationstringRequired

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

Response

OK
idstring or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
namestring or null
The name of the absence region, as specified by the user. It must be unique within the workspace.
countryCodestring or null

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

countrystring or null
The english name of the country.
locationCodestring or null

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

locationstring or null
The name of the location. It will always be in the related country's language.
isDefaultboolean or null
Indicates whether the absence region is the default absence region. Any new user will be assigned to the default absence region.
numberOfPublicHolidaysinteger or null
The number of public holidays in the absence region.
assignedUserslist of strings or null
The list of user ids assigned to the absence region.