/timeoff/categories

GET https://{subdomain}.workable.com/spi/v3/timeoff/categories

Lists the time off categories configured for your account. Required scope: r_timeoff.

🚧

This particular endpoint uses r_timeoff scope, which can be enabled through the Integrations section found within the Settings menu.

Results

Calling the /timeoff/categories endpoint will return a collection of all time off categories configured for an account. An example of the response follows:

JSON

{
	"categories": [
		{
			"id": "76e",
			"name": "Paid time off ",
			"type": "paid",
			"description": "For vacations, holidays and other paid time away from work."
		},
		{
			"id": "76f",
			"name": "Sick leave",
			"type": "paid",
			"description": "For paid time away from work due to illness or sickness."
		},
		{
			"id": "770",
			"name": "Unpaid leave",
			"type": "unpaid",
			"description": "For unpaid time away from work."
		}
	]
}

Each timeoff category will have the following keys:

key	type	description
id	string	Unique identifier for the time off category
name	string	The name of the time off category
type	string	Two different types are supported, paid and unpaid
description	string	A short description of the time off category