Skip to main content
GET
/
api
/
v1
/
time-booking-keys
cURL
curl --request GET \
  --url https://api.example.com/api/v1/time-booking-keys
import requests

url = "https://api.example.com/api/v1/time-booking-keys"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/time-booking-keys', 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/v1/time-booking-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/api/v1/time-booking-keys"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/time-booking-keys")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/time-booking-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "key": "<string>",
    "company": "<string>",
    "description": "<string>"
  }
]
This endpoint only works if your environment has been updated to BDERest version 63.11.20 or higher. If you are unsure of your BDERest version, you can check it in the Platform under Administration > Time & Security > Status.

Response

200 - application/json

OK

key
string

Identifier of this key. Only unique within one company.

company
string

Company in which this key is present. If a key is referenced in multiple companies, it is included once for each company.

description
string
presenceEffect
enum<string>

Indicates the effect this booking key has on a person's presence status when an active booking exists.

  • PRESENT Considered present (e.g. stamped in)
  • ABSENT Considered absent (e.g. vacation, sickness)
  • NEUTRAL Booking has no effect on presence status (e.g. expiry of remaining annual leave, night surcharge)
Available options:
PRESENT,
ABSENT,
NEUTRAL