List employees (filtered, sorted, paginated)
curl --request GET \
--url https://app.ontime.hosai.app/api/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ontime.hosai.app/api/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ontime.hosai.app/api/employees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ontime.hosai.app/api/employees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ontime.hosai.app/api/employees"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ontime.hosai.app/api/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ontime.hosai.app/api/employees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"designation": "<string>",
"departmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"managerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shiftTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"employmentType": "FullTime",
"joinedDate": "<string>",
"status": "Active",
"exitDate": "<string>",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"preferredName": "<string>",
"dob": "<string>",
"gender": "Male",
"maritalStatus": "Single",
"personalEmail": "<string>",
"personalPhone": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"pincode": "<string>",
"emergencyName": "<string>",
"emergencyRelationship": "<string>",
"emergencyPhone": "<string>",
"subDepartment": "<string>",
"grade": "<string>",
"probationEndDate": "<string>",
"branch": "<string>",
"tags": [
"<string>"
],
"payFrequency": "Monthly",
"bankName": "<string>",
"bankAccountHolder": "<string>",
"pan": "<string>",
"aadhaarLast4": "<string>",
"pfUan": "<string>",
"esiNumber": "<string>",
"ctcAnnual": 0,
"bankAccountNumber": "<string>",
"ifsc": "<string>"
}
],
"total": 0,
"page": 0,
"pageSize": 0,
"kpis": {
"headcount": 0,
"active": 0,
"onboarding": 0,
"probation": 0,
"exited": 0,
"avgTenureYears": 123
}
}Employees
List employees (filtered, sorted, paginated)
List employees (filtered, sorted, paginated)
GET
/
api
/
employees
List employees (filtered, sorted, paginated)
curl --request GET \
--url https://app.ontime.hosai.app/api/employees \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ontime.hosai.app/api/employees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ontime.hosai.app/api/employees', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ontime.hosai.app/api/employees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ontime.hosai.app/api/employees"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ontime.hosai.app/api/employees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ontime.hosai.app/api/employees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"code": "<string>",
"fullName": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"designation": "<string>",
"departmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"managerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"shiftTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"employmentType": "FullTime",
"joinedDate": "<string>",
"status": "Active",
"exitDate": "<string>",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"preferredName": "<string>",
"dob": "<string>",
"gender": "Male",
"maritalStatus": "Single",
"personalEmail": "<string>",
"personalPhone": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"pincode": "<string>",
"emergencyName": "<string>",
"emergencyRelationship": "<string>",
"emergencyPhone": "<string>",
"subDepartment": "<string>",
"grade": "<string>",
"probationEndDate": "<string>",
"branch": "<string>",
"tags": [
"<string>"
],
"payFrequency": "Monthly",
"bankName": "<string>",
"bankAccountHolder": "<string>",
"pan": "<string>",
"aadhaarLast4": "<string>",
"pfUan": "<string>",
"esiNumber": "<string>",
"ctcAnnual": 0,
"bankAccountNumber": "<string>",
"ifsc": "<string>"
}
],
"total": 0,
"page": 0,
"pageSize": 0,
"kpis": {
"headcount": 0,
"active": 0,
"onboarding": 0,
"probation": 0,
"exited": 0,
"avgTenureYears": 123
}
}Authorizations
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
Required range:
1 <= x <= 9007199254740991Required range:
1 <= x <= 100Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Available options:
code, fullName, designation, department, location, manager, joinedDate, status, ctcAnnual Available options:
asc, desc Response
200 - application/json
Success
Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes