List timechecks
curl --request POST \
--url https://api.example.com/api/timeclock/timechecks.list \
--header 'Content-Type: application/json' \
--data '
{
"filters": [
{
"key": "timecheck.ids",
"value": [
"872815618512410358"
]
}
]
}
'import requests
url = "https://api.example.com/api/timeclock/timechecks.list"
payload = { "filters": [
{
"key": "timecheck.ids",
"value": ["872815618512410358"]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({filters: [{key: 'timecheck.ids', value: ['872815618512410358']}]})
};
fetch('https://api.example.com/api/timeclock/timechecks.list', 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://api.example.com/api/timeclock/timechecks.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
[
'key' => 'timecheck.ids',
'value' => [
'872815618512410358'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/timeclock/timechecks.list"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/timeclock/timechecks.list")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/timeclock/timechecks.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"resource_id": "872815618512410358",
"duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"expected_time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"type": "device",
"color": "<string>",
"device": {
"in": {
"time": "2019-11-11T12:34:56",
"name": "<string>",
"beacon_name": "<string>",
"autocorrection": "2019-11-11T12:34:56",
"autocorrection_source": "<string>",
"geolocation": {
"latitude": null,
"longitude": null,
"accuracy": null
},
"received_at": "2025-10-30T10:40:22.01367Z"
},
"out": {
"time": "2019-11-11T12:34:56",
"name": "<string>",
"beacon_name": "<string>",
"autocorrection": "2019-11-11T12:34:56",
"autocorrection_source": "<string>",
"geolocation": {
"latitude": null,
"longitude": null,
"accuracy": null
},
"received_at": "2025-10-30T10:40:22.01367Z"
}
},
"proposal": {
"resource_id": "872815618512410358",
"in": "2019-11-11T12:34:56",
"out": "2019-11-11T12:34:56",
"received_at": "2025-10-30T10:40:22.01367Z",
"comment": null
},
"validation": {
"resource_id": "872815618512410358",
"in": "2019-11-11T12:34:56",
"out": "2019-11-11T12:34:56",
"received_at": "2025-10-30T10:40:22.01367Z",
"comment": null
},
"is_adjusted": true,
"matched_schedule_ids": [
"872815618512410358"
],
"tags_comment": "<string>",
"tags": [
{
"id": "872815618512410358",
"added_at": "2019-11-11T12:34:56",
"added_by": "872815618512410358",
"removed_at": "2019-11-11T12:34:56",
"removed_by": "872815618512410358"
}
]
}
]Timechecks
List timechecks
Retrieves all timecheck details (or the ones corresponding to the provided ids).
Several filters can be used to narrow down the search.
POST
/
api
/
timeclock
/
timechecks.list
List timechecks
curl --request POST \
--url https://api.example.com/api/timeclock/timechecks.list \
--header 'Content-Type: application/json' \
--data '
{
"filters": [
{
"key": "timecheck.ids",
"value": [
"872815618512410358"
]
}
]
}
'import requests
url = "https://api.example.com/api/timeclock/timechecks.list"
payload = { "filters": [
{
"key": "timecheck.ids",
"value": ["872815618512410358"]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({filters: [{key: 'timecheck.ids', value: ['872815618512410358']}]})
};
fetch('https://api.example.com/api/timeclock/timechecks.list', 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://api.example.com/api/timeclock/timechecks.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
[
'key' => 'timecheck.ids',
'value' => [
'872815618512410358'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/timeclock/timechecks.list"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/timeclock/timechecks.list")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/timeclock/timechecks.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": [\n {\n \"key\": \"timecheck.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": "872815618512410358",
"resource_id": "872815618512410358",
"duration": "PT1H30M20S",
"time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"expected_time_range": "2019-11-11T12:34:56/2019-12-12T23:59:59",
"type": "device",
"color": "<string>",
"device": {
"in": {
"time": "2019-11-11T12:34:56",
"name": "<string>",
"beacon_name": "<string>",
"autocorrection": "2019-11-11T12:34:56",
"autocorrection_source": "<string>",
"geolocation": {
"latitude": null,
"longitude": null,
"accuracy": null
},
"received_at": "2025-10-30T10:40:22.01367Z"
},
"out": {
"time": "2019-11-11T12:34:56",
"name": "<string>",
"beacon_name": "<string>",
"autocorrection": "2019-11-11T12:34:56",
"autocorrection_source": "<string>",
"geolocation": {
"latitude": null,
"longitude": null,
"accuracy": null
},
"received_at": "2025-10-30T10:40:22.01367Z"
}
},
"proposal": {
"resource_id": "872815618512410358",
"in": "2019-11-11T12:34:56",
"out": "2019-11-11T12:34:56",
"received_at": "2025-10-30T10:40:22.01367Z",
"comment": null
},
"validation": {
"resource_id": "872815618512410358",
"in": "2019-11-11T12:34:56",
"out": "2019-11-11T12:34:56",
"received_at": "2025-10-30T10:40:22.01367Z",
"comment": null
},
"is_adjusted": true,
"matched_schedule_ids": [
"872815618512410358"
],
"tags_comment": "<string>",
"tags": [
{
"id": "872815618512410358",
"added_at": "2019-11-11T12:34:56",
"added_by": "872815618512410358",
"removed_at": "2019-11-11T12:34:56",
"removed_by": "872815618512410358"
}
]
}
]Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Response
200 - application/json
Example:
"872815618512410358"
Example:
"872815618512410358"
Example:
"PT1H30M20S"
Example:
"2019-11-11T12:34:56/2019-12-12T23:59:59"
Example:
"2019-11-11T12:34:56/2019-12-12T23:59:59"
Available options:
device, adjusted, proposal, validation Example:
"device"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I