Skip to main content
GET
Live working-days + balance-after preview for an apply form

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Query Parameters

leaveTypeId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
fromDate
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
toDate
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
duration
enum<string>
default:FullDay
Available options:
FullDay,
FirstHalf,
SecondHalf

Response

200 - application/json

Success

workingDays
number
required
weekendDaysExcluded
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
holidayDaysExcluded
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
currentRemaining
number
required
balanceAfter
number
required
insufficient
boolean
required
conflict
boolean
required
conflictDates
string[]
required
requiresHrApproval
boolean
required
leaveTypeName
string
required