Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Policy

Create a time off policy

post/v1/workspaces/{workspaceId}/time-off/policies

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ec61a8

Represents a workspace identifier across the system.

Request body

allowHalfDayboolean

Indicates whether policy allows half days.

allowNegativeBalanceboolean

Indicates whether policy allows negative balances.

archivedboolean

Indicates whether policy is archived.

colorstring

Provide color in format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

everyoneIncludingNewboolean

Indicates whether the policy is to be applied to future new users.

hasExpirationboolean

Indicates whether the policy balance should have expiration

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

Provide icon.

namestring required

Represents a name of new policy.

timeUnit'DAYS' | 'HOURS'

Indicates time unit of the policy.

Example request

{
  "allowNegativeBalance": true,
  "approve": {
    "requiresApproval": true,
    "userIds": [
      "6579d126c2fe3b25f20ea001",
      "6579d126c2fe3b25f20ea002"
    ]
  },
  "archived": true,
  "automaticAccrual": {
    "amount": 2,
    "period": "MONTH"
  },
  "color": "#8BC34A",
  "icon": "UMBRELLA",
  "name": "Mental health days",
  "negativeBalance": {
    "amount": 2,
    "period": "MONTH",
    "shouldReset": true
  },
  "timeUnit": "DAYS",
  "userGroups": {
    "contains": "CONTAINS",
    "ids": [
      "5b715612b079875110791111",
      "5b715612b079875110791222"
    ],
    "status": "ALL"
  },
  "users": {
    "contains": "CONTAINS",
    "ids": [
      "5b715612b079875110791111",
      "5b715612b079875110791222"
    ],
    "status": "ALL"
  }
}

Response

Created

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"
}