Shift template library + coverage/KPIs
curl --request GET \
--url https://app.ontime.hosai.app/api/shifts \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ontime.hosai.app/api/shifts"
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/shifts', 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/shifts",
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/shifts"
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/shifts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ontime.hosai.app/api/shifts")
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",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"allLocations": true,
"locationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"effectiveFrom": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"workingHours": 123,
"unpaidBreakMinutes": 0,
"breakWindowStart": "<string>",
"breakWindowEnd": "<string>",
"gracePeriodMinutes": 0,
"halfDayCutoffHours": 123,
"weeklyOff": [
"<string>"
],
"autoCheckoutAfter": "<string>",
"otEligibleAfterMinutes": 0,
"otCapPerDayMinutes": 0,
"otMultiplierWeekday": 9,
"otMultiplierHolidayOff": 9,
"otApprovalThresholdMinutes": 0,
"workingDays": {
"mon": true,
"tue": true,
"wed": true,
"thu": true,
"fri": true,
"sat": true,
"sun": true,
"secondSatOff": true,
"fourthSatOff": true,
"restrictedHolidays": true
},
"punchSources": {
"biometricOffice": {
"enabled": true,
"hint": "<string>"
},
"mobileGpsSelfie": {
"enabled": true,
"hint": "<string>"
},
"mobileOtpFallback": {
"enabled": true,
"hint": "<string>"
},
"webWfh": {
"enabled": true,
"hint": "<string>"
},
"qrKiosk": {
"enabled": true,
"hint": "<string>"
},
"managerMarked": {
"enabled": true,
"hint": "<string>"
}
},
"lateDeduction": {
"afterCount": 0,
"fraction": 123
},
"notifications": [
{
"label": "<string>",
"channelTarget": "<string>"
}
],
"assignedCount": 0
}
],
"total": 0,
"kpis": {
"total": 0,
"published": 0,
"draft": 0,
"employeesCovered": 0,
"employeesUnassigned": 0,
"avgWorkingHours": 123
},
"shiftLoadByCategory": [
{
"count": 0
}
],
"coverageByLocation": [
{
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationName": "<string>",
"total": 0,
"byCategory": [
{
"count": 0
}
]
}
]
}Shifts
Shift template library + coverage/KPIs
Shift template library + coverage/KPIs
GET
/
api
/
shifts
Shift template library + coverage/KPIs
curl --request GET \
--url https://app.ontime.hosai.app/api/shifts \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ontime.hosai.app/api/shifts"
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/shifts', 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/shifts",
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/shifts"
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/shifts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ontime.hosai.app/api/shifts")
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",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"allLocations": true,
"locationIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"effectiveFrom": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"workingHours": 123,
"unpaidBreakMinutes": 0,
"breakWindowStart": "<string>",
"breakWindowEnd": "<string>",
"gracePeriodMinutes": 0,
"halfDayCutoffHours": 123,
"weeklyOff": [
"<string>"
],
"autoCheckoutAfter": "<string>",
"otEligibleAfterMinutes": 0,
"otCapPerDayMinutes": 0,
"otMultiplierWeekday": 9,
"otMultiplierHolidayOff": 9,
"otApprovalThresholdMinutes": 0,
"workingDays": {
"mon": true,
"tue": true,
"wed": true,
"thu": true,
"fri": true,
"sat": true,
"sun": true,
"secondSatOff": true,
"fourthSatOff": true,
"restrictedHolidays": true
},
"punchSources": {
"biometricOffice": {
"enabled": true,
"hint": "<string>"
},
"mobileGpsSelfie": {
"enabled": true,
"hint": "<string>"
},
"mobileOtpFallback": {
"enabled": true,
"hint": "<string>"
},
"webWfh": {
"enabled": true,
"hint": "<string>"
},
"qrKiosk": {
"enabled": true,
"hint": "<string>"
},
"managerMarked": {
"enabled": true,
"hint": "<string>"
}
},
"lateDeduction": {
"afterCount": 0,
"fraction": 123
},
"notifications": [
{
"label": "<string>",
"channelTarget": "<string>"
}
],
"assignedCount": 0
}
],
"total": 0,
"kpis": {
"total": 0,
"published": 0,
"draft": 0,
"employeesCovered": 0,
"employeesUnassigned": 0,
"avgWorkingHours": 123
},
"shiftLoadByCategory": [
{
"count": 0
}
],
"coverageByLocation": [
{
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationName": "<string>",
"total": 0,
"byCategory": [
{
"count": 0
}
]
}
]
}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.
Response
200 - application/json
Success
⌘I