Skip to main content
GET
Get a time-off policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Response

200 - application/json
object | null

OK

id
string<uuid>
required
organization_id
string | null
required
accrual_cycle_id
string | null
required
activity_type
enum<string>
required
Available options:
not_working_paid,
not_working_unpaid,
working
allowance_entitlement
enum<string>
required
Available options:
base_annual_allowance,
unlimited
annual_allowance
integer
required
balance_rounding
enum<string>
required
Available options:
nearest,
round_up
color
enum<string>
required
Available options:
cyan,
sky,
blue,
indigo,
pink,
rose,
red,
lime,
green,
emerald,
teal,
purple,
violet,
yellow,
orange,
amber,
gray,
zinc
country_code
enum<string>
required
Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
deductible_days
enum<string>
required
Available options:
any_day,
any_day_excluding_holidays,
workdays_only
description
string
required
effective_date
string
required
is_active
boolean
required
is_approval_required
boolean
required
is_request_note_mandatory
boolean
required
max_carryover_days
integer | null
required
name
string
required
notice_period
enum<string> | null
required
Available options:
days,
weeks,
months
notice_period_count
integer | null
required
precision
enum<string>
required
Available options:
one_decimal_place,
two_decimal_places,
half,
whole_number
request_attachment_requirement
enum<string>
required
Available options:
none,
optional,
mandatory
shortest_request_amount
enum<string>
required
Available options:
half_day,
day
document_template_id
string<uuid> | null
required
approval_document_template_id
string<uuid> | null
required
decline_document_template_id
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time> | null
required
employee_ids
string<uuid>[]
required