Skip to main content
GET
cURL

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

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:50
Required range: 1 <= x <= 100
status
string
employmentType
string
departmentId
string
locationId
string
managerId
string
tags
string
branch
string
reportsTo
string
tenureMinMonths
integer
Required range: 0 <= x <= 9007199254740991
tenureMaxMonths
integer
Required range: 0 <= x <= 9007199254740991
designation
string
grade
string
joinedFrom
string
joinedTo
string
ctcMin
integer
Required range: -9007199254740991 <= x <= 9007199254740991
ctcMax
integer
Required range: -9007199254740991 <= x <= 9007199254740991
sortField
enum<string>
default:code
Available options:
code,
fullName,
designation,
department,
location,
manager,
joinedDate,
status,
ctcAnnual
sortDir
enum<string>
default:asc
Available options:
asc,
desc

Response

200

Success