Create a time off policy

Creates a time off policy for a company. A policy sets how hours accrue automatically, and the limits, rollover, and waiting periods that apply. Set the options object that matches accrual_method and leave the others null.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Sandbox beta only

The Time Off API is in beta and is only available in Sandbox. For more details, see Working with Time Off Policies.

Body Params
string
required

ID of the company the policy belongs to.

string
required

Name of the policy.

policy_year
object

The annual cycle of the policy.

string
enum
required

How hours are accrued automatically. One of annual_grant, per_payroll, per_hour_worked, or none. Can't be changed after the policy is created.

Allowed:
annual_grant_options
object | null

Settings for annual_grant policies. null for other accrual methods.

per_payroll_options
object | null

Settings for per_payroll policies. null for other accrual methods.

per_hour_worked_options
object | null

Settings for per_hour_worked policies. null for other accrual methods.

limits
object

Caps on balances and accrual under the policy. A null limit isn't enforced.

integer

Days after the balance's first enrollment before automatic accrual starts.

integer

Days after the balance's first enrollment before spending hours stops returning a warning.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json