Gets all the absence regions.

GET

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.

Required Permissions: Any authenticated user.

Response

OK

idstringOptional
createdOndatetimeOptional
createdBystringOptional
updatedOndatetimeOptional
updatedBystringOptional
namestringOptional

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

countryCodestringOptional

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

countrystringOptional

The english name of the country.

locationCodestringOptional

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

locationstringOptional

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 stringsOptional

The list of user ids assigned to the absence region.