Zum Hauptinhalt springen

Public API – Trauerfälle

Das Trauerfall-Objekt mit allen Feldern sowie Trauerfälle auflisten, abrufen, anlegen und ändern.

Verfasst von Support Team

Der Trauerfall ist das zentrale Objekt der Public API. Termine, Dokumente und der RIP Tag hängen immer an einem Trauerfall. Du sprichst einen Trauerfall über seine uuid an.

Methode

Pfad

Zweck

GET

/cases

Trauerfälle auflisten

GET

/cases/{uuid}

Einen Trauerfall abrufen

POST

/cases

Trauerfall anlegen

PATCH

/cases/{uuid}

Trauerfall ändern

Prozessschritte, Pause, Archivieren und Abschließen beschreibt Prozess, Pause und Abschluss.

Trauerfälle lassen sich über die API nicht löschen. Nicht mehr benötigte Fälle archivierst du.

Das Trauerfall-Objekt

Alle Endpunkte, die einen Trauerfall zurückgeben, liefern dasselbe Objekt.

Grunddaten

Feld

Typ

Beschreibung

uuid

String

Eindeutige Kennung. Nutze sie für alle Aufrufe.

id

Integer

Interne ID. Taucht als case_id an Terminen auf.

organization_id

Integer

ID deines Unternehmens

first_name

String

Vorname der verstorbenen Person

last_name

String

Nachname

deceased_name

String

Vor- und Nachname. Wird automatisch gebildet.

date_of_birth

String oder null

Geburtsdatum, YYYY-MM-DD

date_of_death

String oder null

Sterbedatum, YYYY-MM-DD

notes

String oder null

Interne Notiz. Angehörige sehen sie nicht.

status

String

active oder archived

created_at

String

Angelegt am, YYYY-MM-DD HH:MM:SS

updated_at

String

Zuletzt geändert am

created_by

Integer

ID des Mitarbeiters, der den Fall angelegt hat

creator_first_name, creator_last_name

String

Name dieses Mitarbeiters

Zuständigkeit

Feld

Typ

Beschreibung

assigned_user_ids

Integer[]

Zugewiesene Mitarbeiter. Der erste ist hauptverantwortlich.

assigned_to

Integer oder null

Hauptverantwortliche Person (erster Eintrag in assigned_user_ids)

assigned_first_name, assigned_last_name

String oder null

Name dieser Person

branch_id

Integer oder null

Standort aus GET /branches

Bestattungsart und Prozess

Feld

Typ

Beschreibung

burial_type_id

Integer oder null

Bestattungsart aus GET /burial-types

burial_type_name

String oder null

Name der Bestattungsart

burial_type_color_primary, burial_type_color_secondary

String oder null

Farben der Bestattungsart

steps

Array

Prozessschritte der Bestattungsart (siehe unten). Leer ohne Bestattungsart.

current_step_index

Integer oder null

Erreichter Schritt als Index in steps (0 = erster Schritt). null = noch kein Schritt erreicht.

is_paused

Integer

1, wenn die Automatik pausiert ist

Adressen

Feld

Typ

Beschreibung

addresses

Array

Adressen des Falls (siehe unten)

pickup_address, pickup_latitude, pickup_longitude

String oder null

Veraltet. Kopie der Abholadresse – nutze addresses.

Link für Angehörige

Feld

Typ

Beschreibung

customer_link_url

String

Link für Angehörige, zum Beispiel https://de.rip-app.business/t/{uuid}

feature_chat_enabled

Integer

1 = Chat im Link eingeschaltet

feature_contact_enabled

Integer

1 = zugewiesene Mitarbeiter als Ansprechpartner im Link sichtbar

feature_map_enabled

Integer

1 = Karte im Link sichtbar

feature_shop_enabled

Integer

1 = Shop im Link sichtbar (nur mit Modul Endkundenshop)

map_mode

String

Standort auf der Karte: exact (genau) oder approximate (ungefähr, Kreis von ca. 1,5 km)

link_visit_count

Integer

Anzahl der Besuche des Links durch Angehörige

link_last_visit_at

String oder null

Letzter Besuch, ISO 8601

Besuche zählen ohne Cookies: Mehrere Aufrufe desselben Geräts innerhalb von 30 Minuten zählen einmal. Aufrufe angemeldeter Mitarbeiter und Link-Vorschauen in Messengern zählen nicht. POST /cases liefert die beiden Besuchsfelder nicht mit.

RIP Tag

Feld

Typ

Beschreibung

tag_uuid

String oder null

Kennung des verbundenen RIP Tags

tag_startcode

String oder null

Startcode des RIP Tags, zum Beispiel K7M2-9QXA

tag_last_seen_at

String oder null

Letzte Sichtung des RIP Tags, ISO 8601

tag_last_source

String oder null

Quelle der letzten Sichtung: tracker, station oder app_activation

tag_last_latitude, tag_last_longitude

String oder null

Letzte bekannte Position des RIP Tags (immer genau, unabhängig von map_mode)

Die vier tag_last_*-Felder sind nur vorhanden, wenn ein RIP Tag verbunden ist. In Listen tauchen sie bei allen Fällen auf (dann mit null), sobald mindestens ein Fall der Liste einen RIP Tag hat. Prüfe also auf „fehlt oder null“. Während einer Pause bleibt die Position auf dem letzten Stand vor der Pause.

Abschluss

Feld

Typ

Beschreibung

completed_at

String oder null

Abgeschlossen am. null = noch offen.

burial_latitude, burial_longitude

String oder null

Koordinaten der letzten Ruhestätte

burial_address

String oder null

Adresse oder Beschreibung der letzten Ruhestätte

burial_note

String oder null

Notiz zur Ruhestätte, zum Beispiel die Grabnummer. Angehörige sehen sie im Link. Max. 500 Zeichen.

Prozessschritte (steps[])

Feld

Typ

Beschreibung

id

Integer

ID des Schritts. Brauchst du als step_id für Termine.

name

String

Name des Schritts

position

Integer

Reihenfolge, beginnend bei 0

has_auto_trigger

Integer

1, wenn der Schritt automatisch erreicht werden kann (RIP Tag, Abholadresse, Lieferadresse oder Ort)

collect_date

Integer

1, wenn zu diesem Schritt ein Termin erfasst wird

date_mode

String

date (nur Datum) oder datetime (Datum und Uhrzeit)

is_public

Integer

1, wenn der Schritt im Link für Angehörige erscheint

advance_on_date

Integer

Veraltet, immer 0. Termine schalten den Prozess nie weiter.

Adressen (addresses[])

Jeder Fall hat höchstens eine Adresse pro Typ.

Feld

Typ

Beschreibung

type

String

pickup (Abholadresse), delivery (Lieferadresse), death (Sterbeort) oder birth (Geburtsort)

address

String oder null

Adresse als Text

latitude, longitude

String oder null

Koordinaten

place_id

String oder null

Google-Places-ID, falls vorhanden

Abhol- und Lieferadresse mit Koordinaten nutzt die Automatik, um Schritte bei Ankunft oder Abfahrt weiterzuschalten.

Beispiel

{
  "id": 1287,
  "uuid": "3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47",
  "organization_id": 7,
  "deceased_name": "Gisela Neumann",
  "first_name": "Gisela",
  "last_name": "Neumann",
  "date_of_birth": "1938-04-02",
  "date_of_death": "2026-11-10",
  "burial_type_id": 6,
  "pickup_latitude": "52.51627600",
  "pickup_longitude": "13.27704100",
  "pickup_address": "Seniorenresidenz Am Lindenpark, Parkstraße 8, 14052 Berlin",
  "burial_latitude": null,
  "burial_longitude": null,
  "burial_address": null,
  "burial_note": null,
  "completed_at": null,
  "tag_uuid": "e4a1c9d2-7b3f-4e8a-9d6c-2f5b8a1e0c74",
  "tag_startcode": "K7M2-9QXA",
  "current_step_index": 1,
  "feature_chat_enabled": 1,
  "feature_shop_enabled": 0,
  "feature_contact_enabled": 1,
  "feature_map_enabled": 1,
  "map_mode": "exact",
  "is_paused": 0,
  "branch_id": 3,
  "status": "active",
  "created_by": 14,
  "assigned_to": 15,
  "created_at": "2026-11-10 14:32:05",
  "updated_at": "2026-11-11 08:15:42",
  "notes": "Familie wünscht eine Trauerfeier im kleinen Kreis.",
  "burial_type_name": "Feuerbestattung",
  "burial_type_color_primary": "#6b2737",
  "burial_type_color_secondary": "#c4a0a0",
  "creator_first_name": "Jonas",
  "creator_last_name": "Berger",
  "assigned_first_name": "Lea",
  "assigned_last_name": "Hoffmann",
  "tag_last_seen_at": "2026-11-11T08:14:57+01:00",
  "tag_last_source": "tracker",
  "tag_last_latitude": "52.516301",
  "tag_last_longitude": "13.277012",
  "assigned_user_ids": [15, 18],
  "steps": [
    { "id": 41, "name": "RIP Tag angebracht", "position": 0, "has_auto_trigger": 1, "collect_date": 0, "date_mode": "date", "is_public": 1, "advance_on_date": 0 },
    { "id": 42, "name": "Abholung", "position": 1, "has_auto_trigger": 1, "collect_date": 1, "date_mode": "datetime", "is_public": 1, "advance_on_date": 0 },
    { "id": 43, "name": "Im Krematorium", "position": 2, "has_auto_trigger": 1, "collect_date": 0, "date_mode": "date", "is_public": 1, "advance_on_date": 0 },
    { "id": 44, "name": "Trauerfeier", "position": 3, "has_auto_trigger": 0, "collect_date": 1, "date_mode": "datetime", "is_public": 1, "advance_on_date": 0 },
    { "id": 45, "name": "Beisetzung", "position": 4, "has_auto_trigger": 0, "collect_date": 1, "date_mode": "date", "is_public": 1, "advance_on_date": 0 }
  ],
  "addresses": [
    { "type": "pickup", "address": "Seniorenresidenz Am Lindenpark, Parkstraße 8, 14052 Berlin", "latitude": "52.51627600", "longitude": "13.27704100", "place_id": null },
    { "type": "birth", "address": "Görlitz", "latitude": null, "longitude": null, "place_id": null }
  ],
  "link_visit_count": 3,
  "link_last_visit_at": "2026-11-11T19:02:11+01:00",
  "customer_link_url": "https://de.rip-app.business/t/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47"
}

Trauerfälle auflisten

GET /cases

Liefert alle Trauerfälle deines Unternehmens, die nicht archiviert sind – auch abgeschlossene. Die neuesten stehen oben. Es gibt keine Paginierung.

Query-Parameter

Parameter

Typ

Pflicht

Beschreibung

status

String

nein

archived liefert nur archivierte Fälle. Andere Werte werden ignoriert.

curl "https://de.rip-app.business/api/public/v1/cases" \
  -H "Authorization: Bearer $RIP_API_KEY"
curl "https://de.rip-app.business/api/public/v1/cases?status=archived" \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK

{
  "success": true,
  "count": 2,
  "data": [
    {
      "id": 1287,
      "uuid": "3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47",
      "deceased_name": "Gisela Neumann",
      "status": "active",
      "current_step_index": 1,
      "customer_link_url": "https://de.rip-app.business/t/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47"
    },
    {
      "id": 1279,
      "uuid": "8a3d6f20-1c5e-4b9a-b2d7-4e0f8c1a6d35",
      "deceased_name": "Heinrich Albers",
      "status": "active",
      "current_step_index": 4,
      "customer_link_url": "https://de.rip-app.business/t/8a3d6f20-1c5e-4b9a-b2d7-4e0f8c1a6d35"
    }
  ]
}

Jeder Eintrag ist ein vollständiges Trauerfall-Objekt. Das Beispiel ist gekürzt.

Trauerfall abrufen

GET /cases/{uuid}

Liefert einen Trauerfall – archiviert oder nicht.

curl https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47 \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK mit dem Trauerfall in data (siehe Beispiel oben).

Code

error

Ursache

400

Ungültige UUID

UUID hat ein falsches Format

404

Sterbefall nicht gefunden

UUID unbekannt oder aus einem anderen Unternehmen

Trauerfall anlegen

POST /cases

Legt einen Trauerfall an. Pflicht sind nur Vor- und Nachname. Alles andere kannst du später mit PATCH ergänzen.

Body-Parameter

Parameter

Typ

Pflicht

Beschreibung

first_name

String

ja

Vorname, max. 100 Zeichen

last_name

String

ja

Nachname, max. 100 Zeichen

date_of_birth

String

nein

Geburtsdatum, YYYY-MM-DD

date_of_death

String

nein

Sterbedatum, YYYY-MM-DD

burial_type_id

Integer

nein

Bestattungsart aus GET /burial-types

branch_id

Integer

nein

Standort aus GET /branches

assigned_user_ids

Integer[]

nein

Mitarbeiter aus GET /users. Der erste ist hauptverantwortlich.

notes

String

nein

Interne Notiz

addresses

Array

nein

Adressen, je Eintrag type, address, latitude, longitude, optional place_id

feature_chat_enabled

0 oder 1

nein

Chat im Link für Angehörige

feature_contact_enabled

0 oder 1

nein

Ansprechpartner im Link

feature_map_enabled

0 oder 1

nein

Karte im Link

feature_shop_enabled

0 oder 1

nein

Shop im Link. Nur mit Modul Endkundenshop, sonst 403.

map_mode

String

nein

exact oder approximate

Fehlen die feature_*-Felder oder map_mode, gelten die Voreinstellungen deines Unternehmens unter Einstellungen → Kundenlink.

burial_note, status und current_step_index kannst du beim Anlegen nicht setzen.

curl -X POST https://de.rip-app.business/api/public/v1/cases \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Gisela",
    "last_name": "Neumann",
    "date_of_birth": "1938-04-02",
    "date_of_death": "2026-11-10",
    "burial_type_id": 6,
    "branch_id": 3,
    "assigned_user_ids": [15, 18],
    "notes": "Familie wünscht eine Trauerfeier im kleinen Kreis.",
    "addresses": [
      {
        "type": "pickup",
        "address": "Seniorenresidenz Am Lindenpark, Parkstraße 8, 14052 Berlin",
        "latitude": 52.516276,
        "longitude": 13.277041
      },
      { "type": "birth", "address": "Görlitz" }
    ],
    "feature_chat_enabled": 1,
    "map_mode": "exact"
  }'
// Node.js 18+
const res = await fetch("https://de.rip-app.business/api/public/v1/cases", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RIP_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    first_name: "Gisela",
    last_name: "Neumann",
    date_of_death: "2026-11-10",
    burial_type_id: 6,
    assigned_user_ids: [15, 18],
  }),
});
const body = await res.json();
if (res.status !== 201) throw new Error(`${res.status}: ${body.error}`);
console.log(body.data.uuid, body.data.customer_link_url);

Antwort 201 Created mit dem neuen Trauerfall in data. current_step_index ist null, status ist active.

Code

error

Ursache

400

Ungültige Anfrage

Body fehlt oder ist kein gültiges JSON

400

Vorname und Nachname sind Pflichtfelder

first_name oder last_name fehlt oder ist leer

400

Vorname/Nachname zu lang (max. 100 Zeichen)

Name zu lang

400

Ungültiges Geburtsdatum (Format: YYYY-MM-DD)

Datum im falschen Format (gilt ebenso für das Sterbedatum)

400

Die ausgewählte Bestattungsart gehört nicht zur Organisation

burial_type_id unbekannt

400

Die ausgewählte Filiale gehört nicht zur Organisation

branch_id unbekannt

400

Mindestens ein Mitarbeiter gehört nicht zur Organisation

Eine ID in assigned_user_ids ist unbekannt

403

Noch nicht freigeschaltet. Aktiviere den Endkundenshop im Shop.

feature_shop_enabled: 1 ohne Modul

POST /cases legt bei jedem Aufruf einen neuen Fall an. Wiederhole den Request nach einem Timeout erst, wenn du per GET /cases geprüft hast, dass der Fall noch nicht existiert.

Trauerfall ändern

PATCH /cases/{uuid}

Ändert nur die Felder, die du mitschickst. Die Antwort enthält den vollständigen Trauerfall nach der Änderung.

Body-Parameter

Parameter

Typ

Beschreibung

first_name, last_name

String

Darf nicht leer sein, max. 100 Zeichen. deceased_name wird angepasst.

date_of_birth, date_of_death

String oder null

YYYY-MM-DD. null oder "" löscht das Datum.

burial_type_id

Integer oder null

Bestattungsart wechseln oder entfernen (Folgen siehe unten)

branch_id

Integer oder null

Standort setzen oder entfernen

assigned_user_ids

Integer[]

Ersetzt alle Zuweisungen. [] entfernt alle. Der erste ist hauptverantwortlich.

notes

String oder null

Interne Notiz. "" oder null löscht sie.

burial_note

String oder null

Öffentliche Notiz zur Ruhestätte. Längere Texte werden nach 500 Zeichen abgeschnitten. Auch nach dem Abschluss änderbar.

addresses

Array

Setzt die genannten Adresstypen. Ein Eintrag nur mit type löscht diese Adresse. Nicht genannte Typen bleiben unverändert.

feature_chat_enabled, feature_contact_enabled, feature_map_enabled, feature_shop_enabled

0 oder 1

Funktionen im Link für Angehörige

map_mode

String

exact oder approximate. Unbekannte Werte werden als exact gespeichert.

status

String

active oder archived

current_step_index

Integer oder null

Prozessschritt setzen – wie POST /cases/{uuid}/step

paused

Boolean

Automatik pausieren oder fortsetzen – siehe Prozess, Pause und Abschluss

paused wird immer allein verarbeitet: Enthält der Body paused, ignoriert die API alle anderen Felder dieses Requests.

curl -X PATCH https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47 \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "map_mode": "approximate",
    "assigned_user_ids": [15],
    "addresses": [
      {
        "type": "delivery",
        "address": "Krematorium Am Wiesengrund, Wiesenweg 5, 13599 Berlin",
        "latitude": 52.53318,
        "longitude": 13.21452
      },
      { "type": "birth" }
    ]
  }'

Hier wird der Standort im Link auf „ungefähr“ gestellt, Murat Yilmaz aus der Zuweisung entfernt, eine Lieferadresse gesetzt und der Geburtsort gelöscht.

Antwort 200 OK mit dem aktualisierten Trauerfall in data.

Bestattungsart wechseln

Wechselst du burial_type_id, passiert Folgendes:

  • current_step_index wird auf null zurückgesetzt – außer du schickst im selben Request einen neuen current_step_index mit.

  • Termine, die an Schritte der alten Bestattungsart gebunden waren, bleiben als freie Termine erhalten. Sie tragen dann den Namen des Schritts als Bezeichnung.

  • Die Automatik prüft sofort, ob Schritte der neuen Bestattungsart schon erfüllt sind.

Schickst du dieselbe burial_type_id erneut, ändert sich nichts.

Code

error

Ursache

400

Keine zu aktualisierenden Felder angegeben

Kein bekanntes Feld im Body

400

Vorname darf nicht leer sein

Leerer Name

400

Ungültiger Status (erlaubt: active, archived)

Falscher Wert für status

403

Noch nicht freigeschaltet. Aktiviere die Funktion im Shop.

feature_shop_enabled: 1 ohne Modul Endkundenshop

404

Sterbefall nicht gefunden

UUID unbekannt

405

Methode nicht erlaubt

PUT statt PATCH

Weitere 400-Fehler entsprechen denen beim Anlegen.

Hat dies deine Frage beantwortet?