Referenz: Standorte (/v1/sites)

Organisationseinheiten und Standorte als Zuordnungsgrundlage. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

Schlüssel mit dem Recht sites:read Grundlagen aus „Erste Anfrage an die elyph API“

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/sites liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: sites:read.
curl
curl -sS "https://api.elyph.io/v1/sites?limit=50&type=standort" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Antwort lesen

Die Antwort enthält `data` mit den Objekten, `page.next` als Fortsetzungsmarke und `rate` mit dem verbleibenden Abfragekontingent.

Antwort

{
  "data": [
    {
      "reference": "WN",
      "name": "Werk Nord",
      "type": "standort",
      "parent_id": null,
      "country": "DE",
      "jurisdiction": "DE",
      "postal_code": "76131",
      "city": "Karlsruhe",
      "industry": "Metallverarbeitung",
      "employee_count": 240,
      "active": true,
      "updated_at": "2025-12-02T09:00:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 50
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

3
Filter setzen
Verfügbare Filter: `type` — Art der Organisationseinheit, etwa `standort` oder `bereich`. `updated_since` — Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation. `limit` — Anzahl der Objekte je Seite, 1 bis 200. Standard 50. `page` — Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl. Mehrere Filter werden mit `&` verbunden und wirken zusammen.
4
Einzelnes Objekt holen
Der Pfad /v1/sites/{Kennung} liefert genau ein Objekt. Kennung ist `reference` (Kurzzeichen der Einheit). Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/sites/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
reference	string	Kurzzeichen des Standorts.
name	string	Name der Einheit.
type	string	Art, etwa `standort`, `bereich`, `abteilung`.
parent_id	string \| null	Übergeordnete Einheit (UUID).
country	string \| null	Ländercode (ISO 3166-1 alpha-2).
jurisdiction	string \| null	Maßgeblicher Rechtsraum.
postal_code	string \| null	Postleitzahl.
city	string \| null	Ort.
industry	string \| null	Branche der Einheit.
employee_count	number \| null	Beschäftigte — Grundlage für Vergleichswerte.
active	boolean	Ob die Einheit aktiv ist.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
type	Art der Organisationseinheit, etwa `standort` oder `bereich`.	type=standort
updated_since	Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.	updated_since=2026-01-01T00:00:00Z
limit	Anzahl der Objekte je Seite, 1 bis 200. Standard 50.	limit=100
page	Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.	page=eyJ1IjoiMjAy…

Rechte und Methoden

Angabe	Wert
Pfad	/v1/sites
Methoden	GET
Rechte	sites:read
Kennung	`reference` (Kurzzeichen der Einheit)

API-Konsole

Anfrage zusammenstellen, Code kopieren und — angemeldet und mit eigenem Schlüssel — wirklich ausführen. Die Konsole führt ausschließlich lesende Aufrufe aus.

Ressource

Adresse

GET https://api.elyph.io/v1/sites?limit=10

type

Art der Organisationseinheit, etwa `standort` oder `bereich`.

updated_since

Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.

limit

Anzahl der Objekte je Seite, 1 bis 200. Standard 50.

page

Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.

curl

curl -sS "https://api.elyph.io/v1/sites?limit=10" \
  -H "Authorization: Bearer $ELYPH_API_KEY"

Echttest

Nach der Anmeldung führen Sie dieselbe Anfrage hier mit Ihrem eigenen Schlüssel aus. So sieht eine echte Antwort aus:

Beispielantwort

{
  "data": [
    {
      "reference": "WN",
      "name": "Werk Nord",
      "type": "standort",
      "parent_id": null,
      "country": "DE",
      "jurisdiction": "DE",
      "postal_code": "76131",
      "city": "Karlsruhe",
      "industry": "Metallverarbeitung",
      "employee_count": 240,
      "active": true,
      "updated_at": "2025-12-02T09:00:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

Sie können standorte zuverlässig lesen, filtern und mit Ihrem System abgleichen.

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `reference` (Kurzzeichen der Einheit) als stabile Verknüpfung.
Alle Daten bei jedem Lauf neu laden: Mit `updated_since` holen Sie nur Änderungen.

Hintergrund

Die Ressource ist streng auf den Mandanten des Schlüssels begrenzt. Ist der Zugang auf Standorte eingeschränkt, liefert die Liste nur Objekte dieser Standorte. Jede Anfrage wird mit Zeitpunkt, Pfad, Status und Trefferzahl protokolliert und ist in der Verwaltung einsehbar.