Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Policy

Get a time off policy

get/v1/workspaces/{workspaceId}/time-off/policies/{id}

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Represents a workspace identifier across the system.

idstring required

Represents a policy identifier across the system.

Example:63034cd0cb0fb876a57e93ad

Represents a policy identifier across the system.

Response

OK

allowHalfDayboolean

Indicates whether the half day is allowed.

allowNegativeBalanceboolean

Indicates whether the negative balance is allowed.

archivedboolean

Indicates whether the policy is archived.

colorstring

Represents the color assigned to the policy.

everyoneIncludingNewboolean

Indicates whether the policy is applied to future new users.

icon'UMBRELLA' | 'SNOWFLAKE' | 'FAMILY' | 'PLANE' | 'STETHOSCOPE' | 'HEALTH_METRICS' | 'CHILDCARE' | 'LUGGAGE' | 'MONETIZATION' | 'CALENDAR'

Represents the icon assigned to the policy.

idstring

Represents policy identifier across the system.

namestring

Represents the name of the policy.

projectIdstring

Represents project identifier across the system.

timeUnit'DAYS' | 'HOURS'

Represents the time unit of the policy.

userGroupIdsstring[]

Represents user groups' identifiers across the system. Indicates which user groups are included in the policy.

userIdsstring[]

Represents users' identifiers across the system. Indicates which users are included in the policy.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "allowNegativeBalance": true,
  "approve": {
    "requiresApproval": true,
    "userIds": [
      "6579d126c2fe3b25f20ea001",
      "6579d126c2fe3b25f20ea002"
    ]
  },
  "archived": true,
  "automaticAccrual": {
    "amount": 20,
    "period": "YEAR",
    "timeUnit": "DAYS"
  },
  "color": "#8BC34A",
  "icon": "UMBRELLA",
  "id": "5b715612b079875110791111",
  "name": "Days",
  "timeUnit": "DAYS",
  "userGroupIds": [
    "5b715612b079875110791342",
    "5b715612b079875110791324",
    "5b715612b079875110793142"
  ],
  "userIds": [
    "5b715612b079875110791432",
    "5b715612b079875110791234"
  ],
  "workspaceId": "5b715612b079875110792222"
}