Referenz: Behördenvorgänge (/v1/correspondence)

Vorgänge mit Behörde, Aktenzeichen, Frist und Status. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

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

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/correspondence liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: correspondence:read.
curl
curl -sS "https://api.elyph.io/v1/correspondence?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": "VOR-2026-018",
      "title": "Auflage zur wiederkehrenden Prüfung",
      "authority": {
        "name": "Regierungspräsidium Karlsruhe",
        "reference": "RP-54-2026-118"
      },
      "case_type": "auflage",
      "domain": "strahlenschutz",
      "status": "in_bearbeitung",
      "priority": "hoch",
      "due_date": "2026-03-01",
      "owner": {
        "name": "Sabine Kern",
        "email": "sabine.kern@example.com"
      },
      "site": {
        "reference": "WN",
        "name": "Werk Nord"
      },
      "opened_at": "2026-01-10",
      "closed_at": null,
      "updated_at": "2026-01-26T16:20: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`. `due_before` — Nur Objekte mit Termin bis einschließlich diesem Datum. `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/correspondence/{Kennung} liefert genau ein Objekt. Kennung ist `reference` (Vorgangsnummer). Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/correspondence/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
reference	string	Nummer des Vorgangs.
title	string	Betreff des Vorgangs.
authority.name	string \| null	Behörde.
authority.reference	string \| null	Aktenzeichen der Behörde.
case_type	string \| null	Art des Vorgangs, etwa Anzeige, Auflage, Prüfung.
domain	string \| null	Fachgebiet, etwa Strahlenschutz oder Arbeitsschutz.
status	string	Bearbeitungsstand.
priority	string \| null	Dringlichkeit.
due_date	string \| null	Frist.
owner.name	string \| null	Name der verantwortlichen Person.
owner.email	string \| null	E-Mail der verantwortlichen Person.
site.reference	string \| null	Kurzzeichen des Standorts.
site.name	string \| null	Name des Standorts.
opened_at	string \| null	Eröffnung.
closed_at	string \| null	Abschluss.
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
due_before	Nur Objekte mit Termin bis einschließlich diesem Datum.	due_before=2026-03-31
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/correspondence
Methoden	GET
Rechte	correspondence:read
Kennung	`reference` (Vorgangsnummer)

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

status

Statuswert exakt wie im Feld `status`.

due_before

Nur Objekte mit Termin bis einschließlich diesem Datum.

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/correspondence?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": "VOR-2026-018",
      "title": "Auflage zur wiederkehrenden Prüfung",
      "authority": {
        "name": "Regierungspräsidium Karlsruhe",
        "reference": "RP-54-2026-118"
      },
      "case_type": "auflage",
      "domain": "strahlenschutz",
      "status": "in_bearbeitung",
      "priority": "hoch",
      "due_date": "2026-03-01",
      "owner": {
        "name": "Sabine Kern",
        "email": "sabine.kern@example.com"
      },
      "site": {
        "reference": "WN",
        "name": "Werk Nord"
      },
      "opened_at": "2026-01-10",
      "closed_at": null,
      "updated_at": "2026-01-26T16:20:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

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

Häufige Stolpersteine

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