Optimaite

Akten

3 Min. LesezeitAktualisiert 26. Mai 2026Also available in English

Die Cases API ist die zentrale Ressource für die Aktenverwaltung. Jede Akte kann zugewiesene Parteien, Mitarbeiter, Dokumente, Fristen und Notizen haben.

Endpunkte

MethodPathBeschreibung
GET/api/v1/casesAkten auflisten
POST/api/v1/casesAkte erstellen
GET/api/v1/cases/{id}Akte abrufen
PUT/api/v1/cases/{id}Akte aktualisieren
DELETE/api/v1/cases/{id}Akte löschen
GET/api/v1/cases/{id}/partiesParteien einer Akte auflisten
POST/api/v1/cases/{id}/partiesParteien zu einer Akte hinzufügen
PUT/api/v1/cases/{id}/partiesParteien einer Akte ersetzen
GET/api/v1/cases/{id}/staffZugewiesenes Personal auflisten
POST/api/v1/cases/{id}/staffPersonal zu einer Akte hinzufügen
DELETE/api/v1/cases/{id}/staffPersonal von einer Akte entfernen
GET/api/v1/cases/{id}/timelineZeitachsen-Ereignisse einer Akte abrufen
POST/api/v1/cases/{id}/linksZwei Akten verknüpfen
GET/api/v1/cases/{id}/linksAktenverknüpfungen auflisten
DELETE/api/v1/cases/{id}/links/{link_id}Aktenverknüpfung entfernen

Erforderlicher Scope: cases:read für GET-Endpunkte, cases:write für POST/PUT/DELETE, cases:delete für DELETE.

Das Akten-Objekt

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Smith v. Jones -- Employment Dispute",
  "file_number": "AZ-2026-042",
  "status": "active",
  "type": "litigation",
  "description": "Wrongful termination claim filed by former employee.",
  "dezernat": "Employment Law",
  "created_at": "2026-01-15T09:00:00Z",
  "updated_at": "2026-05-20T14:30:00Z",
  "parties": [
    {
      "id": "usr_01ABCDEF",
      "role": "client",
      "name": "John Smith"
    }
  ],
  "staff": [
    {
      "id": "usr_01GHIJKL",
      "name": "Dr. Anna Mueller",
      "role": "lead_attorney"
    }
  ]
}

Akten auflisten

GET /api/v1/cases

Query-Parameter

ParameterTypeBeschreibung
cursorstringPagination-Cursor aus vorheriger Antwort
limitintegerAnzahl der Ergebnisse (1-100, Standard 50)
statusstringFilter nach Status: active, closed, archived
searchstringSuche nach Aktenname oder Aktenzeichen

Antwort

{
  "data": [
    { "id": "...", "name": "...", "file_number": "...", "status": "..." }
  ],
  "pagination": {
    "cursor": "eyJpZCI6IjU1MGU4NDAwIn0=",
    "has_more": true
  }
}

Akte erstellen

POST /api/v1/cases

Request Body

{
  "name": "Smith v. Jones",
  "file_number": "AZ-2026-042",
  "type": "litigation",
  "description": "Wrongful termination claim",
  "dezernat": "Employment Law"
}

Antwort

Liefert 201 Created mit dem vollständigen Akten-Objekt.

Akte aktualisieren

PUT /api/v1/cases/{id}

Request Body

{
  "status": "closed",
  "description": "Case settled out of court."
}

Nur übermittelte Felder werden aktualisiert (partielle Update-Semantik).

Fehlerantworten

StatusCodeBedeutung
400VALIDATION_ERRORUngültiger Request Body
401AUTH_INVALID_KEYFehlender oder ungültiger API-Schlüssel
403AUTH_INSUFFICIENT_SCOPEFehlender Scope cases:read oder cases:write
404CASE_NOT_FOUNDAkten-ID existiert nicht

Nächste Schritte

  • Parteien -- Mit Akten verknüpfte Kontakte verwalten
  • Dokumente -- Akten-Dokumente hochladen und verwalten
  • Fristen -- Rechtliche Fristen verwalten
Was this helpful?