Referenz: Dokumente (/v1/documents)

Freigegebene Dokumente mit Fassung und Freigabe. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

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

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/documents liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: documents:read.
curl
curl -sS "https://api.elyph.io/v1/documents?limit=50&status=approved" \ -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": "DOK-2026-0091",
      "title": "Betriebsanweisung Presse 3",
      "kind": "betriebsanweisung",
      "status": "approved",
      "version": 3,
      "letter_date": null,
      "our_reference": null,
      "their_reference": null,
      "approved_at": "2026-01-29T08:00:00Z",
      "valid_from": "2026-02-01",
      "review_due_at": "2027-02-01",
      "checksum": "sha256:7c1f…",
      "updated_at": "2026-01-29T08: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: `status` — Statuswert exakt wie im Feld `status`. `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/documents/{Kennung} liefert genau ein Objekt. Kennung ist `reference` (Dokumentnummer). Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/documents/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
reference	string	Nummer des Dokuments.
title	string	Titel des Dokuments.
kind	string	Art, etwa Betriebsanweisung, Schreiben, Nachweis.
status	string	`draft`, `approved`, `archived`.
version	number	Fassung.
letter_date	string \| null	Datum des Schreibens.
our_reference	string \| null	Unser Zeichen.
their_reference	string \| null	Ihr Zeichen.
approved_at	string \| null	Freigabe.
valid_from	string \| null	Gültig ab.
review_due_at	string \| null	Nächste Überprüfung.
checksum	string \| null	Prüfsumme der Datei — Nachweis der Unverändertheit.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
status	Statuswert exakt wie im Feld `status`.	status=approved
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/documents
Methoden	GET
Rechte	documents:read
Kennung	`reference` (Dokumentnummer)

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/documents?limit=10

status

Statuswert exakt wie im Feld `status`.

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/documents?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": "DOK-2026-0091",
      "title": "Betriebsanweisung Presse 3",
      "kind": "betriebsanweisung",
      "status": "approved",
      "version": 3,
      "letter_date": null,
      "our_reference": null,
      "their_reference": null,
      "approved_at": "2026-01-29T08:00:00Z",
      "valid_from": "2026-02-01",
      "review_due_at": "2027-02-01",
      "checksum": "sha256:7c1f…",
      "updated_at": "2026-01-29T08:00:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

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

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `reference` (Dokumentnummer) 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.