CHcharthop
timeOffPolicy

Return a particular time off policy by id

get/v1/org/{orgId}/timeoff/policy/{policyId}

Request

Path parameters

orgIdstring required

Org identifier (either id or slug)

policyIdstring required

TimeOff policy id

Response

successful operation

idstring required

Globally unique id of time off policy

orgIdstring required

Org that the time off belongs to

namestring required

Internal policy name

displayNamestring

External policy name displayed to users

descriptionstring

Policy description

guidelinesstring

Policy guidelines

colorstring

Color used to represent the policy

emojistring

Emoji used to represent the policy

type'PTO' | 'TOIL' | 'VACATION' | 'SICK' | 'MEDICAL' | 'JURY' | 'OFFSITE' | 'PARENTAL' | 'UNPAID' | 'DISABILITY_SHORT' | 'DISABILITY_LONG' | 'BEREAVEMENT' | 'MILITARY' | 'RELIGIOUS' | 'VOTING' | 'VOLUNTEER' | 'UNKNOWN'

Type of policy to be created

status'ACTIVE' | 'INACTIVE' required

Status of the policy

allocationType'UPFRONT' | 'UNLIMITED' | 'ACCRUAL'

Whether the time off is accrued, received upfront, or is an unlimited policy

annualAllocationnumber

Number of days allocated annually

maxConsecutiveDaysPerRequestnumber

An optional max number of days allowed per request

minBalancenumber

An optional minimum balance

enableCarryOverBalanceboolean

Enable carry over balance.

maxCarryOverBalancenumber

An optional maximum carry over balance

carryOverExpirationDatestring

Month and day of carry over expiration.

carryOverExpirationMonthsinteger

Months after carry over date that carry over expires.

enablePartialDayRequestsboolean

Allow half day requests

partialDayGranularitynumber

Partial day requests can only be made down to this level of granularity (i.e. request % granularity == 0)

enablePartialDayPeriodboolean

Allow specifying periods of time (e.g. AM, PM) for partial days

disableRequestsboolean

Whether to disable time off requests for this policy

noteRequiredboolean

Whether a note is required for time off requests

enableManagerRequestsboolean

Whether managers can request, edit, and delete time off on behalf of their reports for this policy

filterstring required

CQL used to determine which jobs the policy applies to

holidayCalendarIdstring

an associated holiday calendar, days on this calendar are not deducted from the time off balance

respectPersonCalendarboolean

when true, a holiday calendar applied to the person via calendar eligibility takes precedence over this policy's holidayCalendarId

disableProratedAllocationboolean

whether limited allocation policies are prorated based on person start date

prorationRounding'UP' | 'NEAREST' | 'HALF'

rounding method for prorating calculations

yearStartDatestring

Month and day of policy year rollover. Defaults to January 1.

yearStartDateExpressionstring

Expression for dynamic month and day of policy year rollover.

policyFromDatestring date

The date on which this policy's balance/accrual settings come into effect. The policy may have entries before this date, but it will not generate e.g. accrual entries.

policyUntilDatestring date

The first date after this policy's balance/accrual settings end (i.e. the exclusive end date). The policy may have entries after this date, but it will not generate e.g. accrual entries.

workDaysstring[]

Days of the week that count against the time off balance. Defaults to Monday through Friday if not set.

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateAtstring

updated timestamp

updateIdstring

updated by user id

updateBehalfIdstring

last updated on behalf of user id

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "name": "US Part-Time/Intern",
  "displayName": "PTO",
  "description": "Annual sick days allotted to employees",
  "emoji": "🌴",
  "holidayCalendarId": "588f7ee98f138b19220041a7",
  "policyEvents": [
    {
      "groupId": "588f7ee98f138b19220041a7",
      "title": "Tenure milestones"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}

Changes

No recorded changes to this operation across all 33 revisions of this API.