Zum Hauptinhalt springen

Public API – Referenzdaten

Bestattungsarten, Standorte, Mitarbeiter und Dokument-Tags abrufen – die IDs, die du für Trauerfälle und Dokumente brauchst.

Verfasst von Support Team

Diese vier Endpunkte liefern die Stammdaten deines Unternehmens. Du brauchst ihre IDs, wenn du einen Trauerfall anlegst oder ein Dokument hochlädst. Alle sind reine Lese-Endpunkte.

Methode

Pfad

Liefert

Verwendest du für

GET

/burial-types

Bestattungsarten

burial_type_id am Trauerfall

GET

/branches

Standorte (Filialen)

branch_id am Trauerfall

GET

/users

Mitarbeiter

assigned_user_ids am Trauerfall

GET

/document-tags

Dokument-Tags

tag_ids beim Dokument-Upload

Die Antworten haben die Form { "success": true, "data": [ … ] } – ohne count und ohne Paginierung.

Bestattungsarten abrufen

GET /burial-types

Liefert die Bestattungsarten deines Unternehmens, sortiert nach Name. Die Bestattungsart bestimmt die Prozessschritte eines Trauerfalls. Die Schritte selbst stehen am Trauerfall im Feld steps – siehe Trauerfälle.

Feld

Typ

Beschreibung

id

Integer

ID für burial_type_id

uuid

String

Eindeutige Kennung der Bestattungsart

name

String

Name, zum Beispiel Feuerbestattung

color_primary

String oder null

Hauptfarbe als Hex-Wert

color_secondary

String oder null

Zweitfarbe als Hex-Wert

steps_count

Integer

Anzahl der Prozessschritte

cases_count

Integer

Anzahl der Trauerfälle mit dieser Bestattungsart (inklusive archivierter)

curl https://de.rip-app.business/api/public/v1/burial-types \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": [
    {
      "id": 5,
      "uuid": "0b6f2d1e-8c3a-4e5b-9f7d-2a1c4e6b8d90",
      "name": "Erdbestattung",
      "color_primary": "#1e3a5f",
      "color_secondary": "#c9a84c",
      "steps_count": 4,
      "cases_count": 23
    },
    {
      "id": 6,
      "uuid": "5c2e9a7b-1d4f-4b8e-a6c3-7f0d2e9b4a18",
      "name": "Feuerbestattung",
      "color_primary": "#6b2737",
      "color_secondary": "#c4a0a0",
      "steps_count": 5,
      "cases_count": 41
    },
    {
      "id": 8,
      "uuid": "9e4b7c2a-3f1d-4a6e-b8c5-1d7f0a2e6c39",
      "name": "Seebestattung",
      "color_primary": "#0097a7",
      "color_secondary": "#80deea",
      "steps_count": 4,
      "cases_count": 3
    }
  ]
}

Bestattungsarten und ihre Schritte pflegen Inhaber und Admins unter Einstellungen → Bestattungsarten. Über die API lassen sie sich nur lesen.

Standorte abrufen

GET /branches

Liefert die Standorte (Filialen) deines Unternehmens: zuerst den Hauptstandort, dann die übrigen nach Name. Der Standort eines Trauerfalls erscheint im Link für Angehörige als Kontaktadresse.

Feld

Typ

Beschreibung

id

Integer

ID für branch_id

uuid

String

Eindeutige Kennung

label

String

Bezeichnung des Standorts; beim Hauptstandort standardmäßig der Name des Unternehmens

street

String oder null

Straße und Hausnummer

zip

String oder null

Postleitzahl

city

String oder null

Ort

country

String oder null

Land als Text, zum Beispiel Deutschland

phone

String oder null

Telefonnummer

email

String oder null

E-Mail-Adresse

is_default

Integer

1 für den Hauptstandort, sonst 0

curl https://de.rip-app.business/api/public/v1/branches \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": [
    {
      "id": 3,
      "uuid": "a1d3b2c4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "label": "Bestattungen Berger",
      "street": "Lindenallee 12",
      "zip": "14050",
      "city": "Berlin",
      "country": "Deutschland",
      "phone": "+49 30 5550120",
      "email": "[email protected]",
      "is_default": 1
    },
    {
      "id": 4,
      "uuid": "b7e2c9d1-3a4f-4e6b-9d8c-5f1a0e2b7c36",
      "label": "Filiale Spandau",
      "street": "Carl-Schurz-Straße 21",
      "zip": "13597",
      "city": "Berlin",
      "country": "Deutschland",
      "phone": "+49 30 5550140",
      "email": "[email protected]",
      "is_default": 0
    }
  ]
}

Jedes Unternehmen hat mindestens einen Standort, den Hauptstandort. Er trägt standardmäßig den Namen des Unternehmens, und leere Felder werden aus den Firmendaten (Einstellungen → Unternehmen) ergänzt. Weitere Standorte pflegst du unter Einstellungen → Standorte.

Mitarbeiter abrufen

GET /users

Liefert alle Mitglieder deines Unternehmens, sortiert nach Nachname und Vorname.

Feld

Typ

Beschreibung

id

Integer

ID für assigned_user_ids

first_name

String

Vorname

last_name

String

Nachname

email

String

E-Mail-Adresse

role

String

owner (Inhaber), admin oder member (Mitglied)

avatar_url

String oder null

Adresse des Profilfotos

curl https://de.rip-app.business/api/public/v1/users \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": [
    {
      "id": 14,
      "first_name": "Jonas",
      "last_name": "Berger",
      "email": "[email protected]",
      "role": "owner",
      "avatar_url": "https://de.rip-app.business/uploads/profile-photos/u14-7c1e.jpg"
    },
    {
      "id": 15,
      "first_name": "Lea",
      "last_name": "Hoffmann",
      "email": "[email protected]",
      "role": "admin",
      "avatar_url": null
    },
    {
      "id": 18,
      "first_name": "Murat",
      "last_name": "Yilmaz",
      "email": "[email protected]",
      "role": "member",
      "avatar_url": null
    }
  ]
}

Dokument-Tags abrufen

GET /document-tags

Liefert die Tags, mit denen du Dokumente einordnest: zuerst die System-Tags, dann eigene Tags nach Name. System-Tags wie Krematorium oder Fingerabdruck legt RIP App Business für jedes Unternehmen an. Sie lassen sich nicht umbenennen oder löschen.

Feld

Typ

Beschreibung

id

Integer

ID für tag_ids

uuid

String

Eindeutige Kennung

name

String

Anzeigename

is_system

Integer

1 für System-Tags, 0 für eigene Tags

curl https://de.rip-app.business/api/public/v1/document-tags \
  -H "Authorization: Bearer $RIP_API_KEY"
{
  "success": true,
  "data": [
    { "id": 11, "uuid": "f0a3c6e9-2b5d-4f8a-9c1e-4d7b0a3e6c92", "name": "Fingerabdruck", "is_system": 1 },
    { "id": 9, "uuid": "c4e7a1d3-6f9b-4c2e-8a5d-1b4e7f0a3c68", "name": "Krematorium", "is_system": 1 },
    { "id": 12, "uuid": "e2b5d8f1-4a7c-4e0b-b3d6-9f2c5a8e1b74", "name": "Sterbeurkunde", "is_system": 0 },
    { "id": 13, "uuid": "a9c2e5f8-1b4d-4a7e-8c0f-3e6b9d2a5c17", "name": "Vollmacht", "is_system": 0 }
  ]
}

Eigene Tags legst du unter Einstellungen → Dokument-Tags an.

IDs auflösen und zwischenspeichern

Die IDs sind pro Unternehmen stabil. Lade die Referenzdaten einmal, speichere sie zwischen und aktualisiere sie zum Beispiel einmal täglich.

// Node.js 18+
const BASE_URL = "https://de.rip-app.business/api/public/v1";
const headers = { Authorization: `Bearer ${process.env.RIP_API_KEY}` };
const get = (path) => fetch(`${BASE_URL}${path}`, { headers }).then((r) => r.json());

const [types, branches, users] = await Promise.all([
  get("/burial-types"),
  get("/branches"),
  get("/users"),
]);

const burialTypeId = types.data.find((t) => t.name === "Feuerbestattung")?.id;      // 6
const branchId = branches.data.find((b) => b.is_default === 1)?.id;                 // 3
const leaId = users.data.find((u) => u.email === "[email protected]")?.id; // 15

Suche Mitarbeiter am besten über die E-Mail-Adresse und Bestattungsarten über den Namen. Beides kann sich ändern – prüfe deshalb, ob ein Treffer gefunden wurde, bevor du einen Trauerfall anlegst.

Hat dies deine Frage beantwortet?