Standort abrufen

Beta Die REST-API ist in der Beta. Endpunkte und Felder können sich bis zur Version 1.0.0 noch ändern.

GET/api/v1/company

GET /api/v1/company liefert den Standort, zu dem der API-Key gehört. Der Endpunkt braucht keinen eigenen Scope und funktioniert mit jedem gültigen API-Key. Er eignet sich deshalb gut, um eine neue Anbindung zu testen.

Parameter

Keine. Zusätzliche Abfrageparameter führen zu 400 validation_error.

Antwortfelder

Feld	Typ	Beschreibung
id	String	ID des Standorts
name	String	Name des Standorts
address	Objekt oder null	Die zum Abfragezeitpunkt gültige Adresse des Standorts; null, wenn keine hinterlegt ist
address.street	String oder null	Straße
address.streetNo	String oder null	Hausnummer
address.zip	String oder null	Postleitzahl
address.city	String oder null	Ort
address.province	String oder null	Bundesland bzw. Region, zum Beispiel DE-BE
address.country	String oder null	Land, zum Beispiel DE
timeZone	String	Immer Europe/Berlin. In dieser Zeitzone rechnet TimeMonkey alle Kalendertage (siehe Grundlagen).

Beispiel

curl

Terminal

curl -s https://api.time.monkeymed.de/api/v1/company \
  -H "Authorization: Bearer $TIMEMONKEY_API_KEY"

JavaScript

company.mjs

const response = await fetch('https://api.time.monkeymed.de/api/v1/company', {
  headers: {Authorization: `Bearer ${process.env.TIMEMONKEY_API_KEY}`},
});
const company = await response.json();
console.log(company.name, company.timeZone);

Python

company.py

import os

import requests

response = requests.get(
    "https://api.time.monkeymed.de/api/v1/company",
    headers={"Authorization": f"Bearer {os.environ['TIMEMONKEY_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
company = response.json()
print(company["name"], company["timeZone"])

200 OK

{
  "id": "64f1a2b3c4d5e6f708192a3b",
  "name": "Zahnarztpraxis Dr. Muster",
  "address": {
    "street": "Hauptstr.",
    "streetNo": "1",
    "zip": "10115",
    "city": "Berlin",
    "province": "DE-BE",
    "country": "DE"
  },
  "timeZone": "Europe/Berlin"
}