custom (0) this year (1) next year (2) last year (3)
start_date
DATE
REQUIRED FOR OPTION 0
-
-
end_date
DATE
REQUIRED FOR OPTION 0
-
-
leave_type_ids
NESTED
OPTIONAL
List (Of leave_type_ids)
-
status_id
CUSTOM
OPTIONAL
-
approved and pending (0) pending only (1) approved only (100)
include_leave
BOOLEAN
OPTIONAL
-
-
include_work
BOOLEAN
OPTIONAL
-
-
include_free_restricted
BOOLEAN
OPTIONAL
-
-
Nested object(s)[]
Object name
Param name
Type
Is Nullable?
Required?
Min.
Max.
leave_type_ids
leave_type_id
[Int32]
False
REQUIRED
0
2147483647
POSTget
Route:
{root}/v4/leave/get
Request type
User level
Requires authentication
Response type
BODY
APPROVER
Yes
Array()
Params
Name
Type
Nullable?
Required?
Min.
Max.
Nest
Custom
map_type_id
CUSTOM
REQUIRED
0
4
-
company (0) department (1) tag (2) staff (3) my staff (4)
map_id
INT32
REQUIRED
0
2147483647
-
-
user_status_id
CUSTOM
✓
OPTIONAL
-
disabled (0) active (1) both (99)
leave_type_ids
NESTED
OPTIONAL
List (Of leave_type_ids)
-
date_option
CUSTOM
REQUIRED
0
3
-
custom (0) this year (1) next year (2) last year (3)
start_date
DATE
REQUIRED FOR OPTION 0
-
-
end_date
DATE
REQUIRED FOR OPTION 0
-
-
status_id
CUSTOM
OPTIONAL
-
approved and pending (0) pending only (1) approved only (100) cancelled only (900) declined only (930) approved and declined (1000) cancelled and declined (1010)
Nested object(s)[]
Object name
Param name
Type
Is Nullable?
Required?
Min.
Max.
leave_type_ids
leave_type_id
[Int32]
False
REQUIRED
0
2147483647
POSTvalidate
Route:
{root}/v4/leave/validate
Request type
User level
Requires authentication
Response type
BODY
STAFF
Yes
Single
Params
Name
Type
Nullable?
Required?
Min.
Max.
Nest
Custom
leave_id
[INT32]
✓
OPTIONAL
0
2147483647
-
-
user_id
[INT32]
✓
OPTIONAL
0
2147483647
-
-
leave_type_id
[INT32]
REQUIRED
0
2147483647
-
-
start_date
DATETIME
REQUIRED
-
-
end_date
DATETIME
REQUIRED
-
-
admin
BOOLEAN
OPTIONAL
-
-
note
STRING
OPTIONAL
0
500
-
-
POSTsubmit
Route:
{root}/v4/leave/submit
Request type
User level
Requires authentication
Response type
BODY
STAFF
Yes
Single
Params
Name
Type
Nullable?
Required?
Min.
Max.
Nest
Custom
leave_id
[INT32]
✓
OPTIONAL
0
2147483647
-
-
user_id
INT32
OPTIONAL
0
2147483647
-
-
leave_type_id
INT32
REQUIRED
0
2147483647
-
-
start_date
DATETIME
REQUIRED
-
-
end_date
DATETIME
REQUIRED
-
-
note
STRING
OPTIONAL
0
500
-
-
admin
[BOOLEAN]
REQUIRED
-
-
POSTapprove decline
Route:
{root}/v4/leave/approve-decline
Request type
User level
Requires authentication
Response type
BODY
APPROVER
Yes
Single
Params
Name
Type
Nullable?
Required?
Min.
Max.
Nest
Custom
leave_id
INT32
REQUIRED
0
2147483647
-
-
option_id
CUSTOM
REQUIRED
1
2
-
approve (1) decline (2)
approver_note
STRING
OPTIONAL
0
500
-
-
POSTcancel
Route:
{root}/v4/leave/cancel
Request type
User level
Requires authentication
Response type
BODY
STAFF
Yes
Single
Params
Name
Type
Nullable?
Required?
Min.
Max.
Nest
Custom
leave_id
INT32
REQUIRED
0
2147483647
-
-
cancellation_note
STRING
OPTIONAL
0
500
-
-
admin
[BOOLEAN]
REQUIRED
-
-
Don't have a WhosOff account yet?
Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Saturday, 26th July 2025 to try the full service, for Free!
Cookies are used to store and/or access device information. Providing consent to these technologies allows us to process data such as browsing behaviour. Not consenting or removing consent may adversely affect some features and functions.
AdvertisingEnables storage related to advertising, for example, advertising campaign.
AnalyticsEnables storage related to analytics, for example, visit duration.
TargetingSets consent for sending user data to Google for online advertising purposes.
MarketingSets consent for personalized advertising.