MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

GET api/officehours

Example request:
curl --request GET \
    --get "http://localhost/api/officehours" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/officehours"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

[
    {
        "id": 1,
        "location_id": 1,
        "start": "2026-02-01T00:00:00.000000Z",
        "end": null,
        "description": "ABC",
        "displayEndTime": false,
        "created_at": "2025-12-19T14:51:53.000000Z",
        "updated_at": "2026-01-30T20:23:09.000000Z",
        "schedule_id": null
    }
]
 

Request      

GET api/officehours

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/locations

Example request:
curl --request GET \
    --get "http://localhost/api/locations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/locations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

[
    {
        "id": 2,
        "name": "Kullenhof Office",
        "description": null,
        "address": "Kullenhofstr. 60, 52074 Aachen",
        "latitude": 50.772381,
        "longitude": 6.044733
    },
    {
        "id": 1,
        "name": "KaWo3 Office",
        "description": "Test",
        "address": "Kastanienweg 10, 52074 Aachen",
        "latitude": 50.785576,
        "longitude": 6.052738
    }
]
 

Request      

GET api/locations

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json