Skip to main content
GET
Current employee's profile

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.

Response

200 - application/json

Success

id
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)$
code
string
required
Minimum string length: 1
fullName
string
required
Minimum string length: 1
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
mobile
string
required
designation
string
required
departmentId
string<uuid> | null
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)$
locationId
string<uuid> | null
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)$
managerId
string<uuid> | null
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)$
shiftTemplateId
string<uuid> | null
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)$
employmentType
enum<string>
required
Available options:
FullTime,
Probation,
Contract
joinedDate
string
required
Pattern: ^\d{4}-\d{2}-\d{2}$
status
enum<string>
required
Available options:
Active,
Probation,
Onboarding,
Exited
exitDate
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
roleId
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)$
firstName
string | null
required
middleName
string | null
required
lastName
string | null
required
preferredName
string | null
required
dob
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
gender
enum<string> | null
required
Available options:
Male,
Female,
Other,
Undisclosed
maritalStatus
enum<string> | null
required
Available options:
Single,
Married,
Other
personalEmail
string | null
required
personalPhone
string | null
required
address
string | null
required
city
string | null
required
state
string | null
required
pincode
string | null
required
emergencyName
string | null
required
emergencyRelationship
string | null
required
emergencyPhone
string | null
required
subDepartment
string | null
required
grade
string | null
required
probationEndDate
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
branch
string | null
required
tags
string[]
required
payFrequency
enum<string> | null
required
Available options:
Monthly,
Biweekly,
Weekly
bankName
string | null
required
bankAccountHolder
string | null
required
pan
string | null
aadhaarLast4
string | null
pfUan
string | null
esiNumber
string | null
ctcAnnual
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
bankAccountNumber
string | null
ifsc
string | null