Squadra API Dokumentation

Willkommen zur API-Dokumentation für doc.squadra.work. Die Squadra REST API ermöglicht Ihnen den programmatischen Zugriff auf Ihre Unternehmensdaten wie Mitarbeiter, Verträge, Betriebe, Standorte und Sitzungen.

---

Authentifizierung

Alle Endpunkte werden auf Mandantenebene (pro Firma) ausgeführt. Die Identifikation erfolgt über einen API-Schlüssel, der in jedem HTTP-Header übergeben werden muss.

Sicherheitshinweis

Behandeln Sie Ihren API-Schlüssel wie ein Passwort. Geben Sie ihn nicht in öffentlich zugänglichem Code oder clientseitigen Skripten preis.

Base URL

https://api.squadra.work/v2

Required Header

Header	Typ	Beschreibung
x-api-key	string	Erforderlich. Ihr individueller Firmen-API-Schlüssel.
Content-Type	string	application/json

API-Schlüssel finden

1. Melden Sie sich in der Squadra Web-App an.
2. Navigieren Sie unten links zu Einstellungen.
3. Wählen Sie im linken Menü unter Unternehmen den Punkt API.
4. Kopieren Sie den API-Schlüssel oder generieren Sie bei Bedarf über API-Schlüssel neu generieren einen neuen Schlüssel.

---

Endpunkte

Mitarbeiter (Employees)

Alle Mitarbeiter abrufen

GET /employees

Ruft eine Liste aller Mitarbeiter des Unternehmens ab.

Example Request:

curl -X GET "https://api.squadra.work/v2/employees" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response (200 OK):

[
  {
    "id": "emp_12345",
    "firstName": "Petra",
    "lastName": "Beispiel",
    "email": "petra@squadra.ch"
  }
]

---

Einzelnen Mitarbeiter abrufen

GET /employees/:employeeID

Ruft die Detaildaten eines spezifischen Mitarbeiters ab.

Path Parameters:

Parameter	Typ	Beschreibung
employeeID	string	Erforderlich. Die eindeutige ID des Mitarbeiters.

---

Verträge eines Mitarbeiters abrufen

GET /employees/:employeeID/contracts

Liefert alle Verträge, die einem bestimmten Mitarbeiter zugeordnet sind.

Path Parameters:

Parameter	Typ	Beschreibung
employeeID	string	Erforderlich. Die eindeutige ID des Mitarbeiters.

---

Spezifischen Vertrag abrufen

GET /employees/:employeeID/contracts/:contractID

Ruft Details zu einem spezifischen Vertrag eines Mitarbeiters ab.

Path Parameters:

Parameter	Typ	Beschreibung
employeeID	string	Erforderlich. Die ID des Mitarbeiters.
contractID	string	Erforderlich. Die ID des Vertrags.

---

Betriebe & Standorte (Branches)

Berufsbezeichnungen eines Betriebs abrufen

GET /branches/:branchID/job-titles

Liefert alle definierten Berufsbezeichnungen und Rollen für einen bestimmten Betrieb (z. B. Bar, Casino, Reinigung).

Path Parameters:

Parameter	Typ	Beschreibung
branchID	string	Erforderlich. Die eindeutige ID des Betriebs.

---

Standorte eines Betriebs abrufen

GET /branches/:branchID/locations

Ruft alle Standorte und Adressen ab, die einem bestimmten Betrieb zugewiesen sind.

Path Parameters:

Parameter	Typ	Beschreibung
branchID	string	Erforderlich. Die eindeutige ID des Betriebs.

---

Sitzungen & Schichten (Sessions)

Alle Sitzungen abrufen

GET /sessions

Ruft alle erfassten Zeiteinträge, Schichten oder Sitzungen des Unternehmens ab.

---

Statuscodes & Fehlerbehandlung

Die API verwendet Standard-HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.

Code	Status	Beschreibung
200	OK	Die Anfrage war erfolgreich.
401	Unauthorized	Der x-api-key fehlt, ist ungültig oder abgelaufen.
404	Not Found	Die angeforderte Ressource oder ID existiert nicht.
500	Internal Server Error	Ein serverseitiger Fehler ist aufgetreten.