Zum Inhalt springen

Pulsika-API

Verbinden Sie Ihre Systeme mit Pulsika, um Personaldaten, Standorte, Urlaub, Performance, Weiterbildung und weitere Unternehmensdaten zu lesen und zu aktualisieren. Die API verwendet JSON über HTTPS, mit eigenen Schlüsseln für jedes System und Berechtigungen für jede Ressource.

Die API ist Teil des Tarifs Enterprise.

Erste Schritte

  1. Öffnen Sie als Inhaber oder Administrator des Unternehmens Zugriff → API-Schlüssel und wählen Sie „Neuer Schlüssel“.
  2. Benennen Sie den Schlüssel nach dem System, das ihn nutzt. Geben Sie nur die nötigen Lese- oder Schreibrechte und beschränken Sie den Zugriff, wo möglich, auf die IP-Adressen des Systems.
  3. Kopieren Sie den Schlüssel: Er wird einmal angezeigt. Pulsika speichert nur einen Fingerabdruck davon.
  4. Rufen Sie die Adresse Ihres Unternehmens mit dem Schlüssel im Header Authorization auf.

Jeder Aufruf geht an die eigene Adresse Ihres Unternehmens:

https://compania-mea.pulsika.eu/api/v1
curl https://compania-mea.pulsika.eu/api/v1/employees?per_page=10 \
  -H "Authorization: Bearer hq_12_••••••••"

Authentifizierung

Senden Sie den Schlüssel im Header Authorization als Bearer-Token. Ein Schlüssel funktioniert nur unter der Adresse seines eigenen Unternehmens. Er kann ablaufen, pausiert und fortgesetzt oder jederzeit widerrufen werden; er kann auf IP-Adressen oder Bereiche beschränkt werden. Änderungen werden unter dem Namen der Person erfasst, die den Schlüssel angelegt hat. Verliert sie das Recht, API-Schlüssel zu verwalten, behält der Schlüssel den Lesezugriff, kann aber keine Daten mehr schreiben.

Authorization: Bearer hq_12_••••••••

Berechtigungen

Für jede Ressource kann ein Schlüssel Lese- ({resource}:read) und Schreibrechte ({resource}:write) haben. Sie gelten für die Daten des ganzen Unternehmens. Zwei weitere Berechtigungen gibt es: sensitive, zum Lesen und Schreiben als sensibel markierter eigener Felder, und metrics:write, zum Senden von KPI-Werten über fachliche Referenzen.

Anfragen und Antworten

  • Anfragen und Antworten verwenden JSON mit UTF-8-Kodierung. Senden Sie Content-Type: application/json, wenn Sie einen Anfragetext senden.
  • Verwenden Sie YYYY-MM-DD für Datumsangaben und ISO 8601 für Zeitpunkte. Antworten verwenden UTC, zum Beispiel 2026-05-01T08:00:00Z.
  • Ein einzelner Eintrag wird als {"data": {…}} zurückgegeben, eine Liste als {"data": […], "meta": {page, per_page, total, last_page}, "links": {next, prev}}.
  • Listen: page (ab 1), per_page (standardmäßig 25, höchstens 100), sort (id, created_at, updated_at; ein Minus für absteigend), updated_since (nach einem Zeitpunkt geänderte Einträge, zur Synchronisierung), dazu die Filter jeder Ressource.
  • Legen Sie Einträge mit POST an und aktualisieren Sie sie mit PATCH, wobei Sie nur die geänderten Felder senden. DELETE liefert 204. Anfragen mit nicht schreibbaren Feldern werden abgelehnt.
  • Schreibvorgänge sind atomar: Alle Änderungen werden gemeinsam gespeichert oder keine.
GET https://compania-mea.pulsika.eu/api/v1/employees?status=active&updated_since=2026-05-01T00:00:00Z&page=2

Fehler

Fehler werden als {"error": "<code>", "message": "<text>"} zurückgegeben. Ungültige Daten liefern Status 422 mit Details unter "errors" für jedes betroffene Feld.

StatusCodeBedeutung
401invalid_tokenDer Schlüssel fehlt, ist unbekannt oder gehört zu einem anderen Unternehmen.
403token_inactiveDer Schlüssel ist pausiert oder abgelaufen.
403not_in_planDer Tarif des Unternehmens enthält diese Art von Schlüssel nicht (Automatisierungsschlüssel: ab Professional; die vollständige API: Enterprise).
403insufficient_scopeDem Schlüssel fehlt die für diesen Vorgang nötige Berechtigung.
403ip_not_allowedDer Schlüssel nimmt keine Aufrufe von dieser Adresse an.
403token_owner_inactiveDie Person, die den Schlüssel angelegt hat, darf keine Schlüssel mehr verwalten: Er kann weiter lesen, aber nicht mehr schreiben.
404—Keine solche Ressource oder kein solcher Eintrag in Ihrem Unternehmen (oder nicht in Ihrem Tarif).
405—Die Ressource bietet diesen Vorgang nicht an.
409in_useDer Eintrag wird noch anderswo verwendet und kann nicht gelöscht werden.
422—Ungültige Daten; es wurde nichts gespeichert.
429—Zu viele Anfragen; versuchen Sie es nach Retry-After Sekunden erneut.

Limits

Das Limit beträgt 120 Anfragen pro Minute und Schlüssel und 300 pro IP-Adresse. Bei Überschreitung antwortet die API mit Status 429. Der Header Retry-After gibt an, wie lange bis zum nächsten Versuch zu warten ist.

Versionen

Die aktuelle Version ist 1 (/api/v1). Neue Ressourcen, Felder und Filter werden in dieser Version ergänzt. Inkompatible Änderungen kommen in einer neuen Version, die vorab angekündigt wird.

Personenbezogene Daten

  • Persönliche Kennnummern (Steuer-ID, Sozialversicherungsnummer, die rumänische CNP) können über die API weder gelesen noch geschrieben werden.
  • Der Zugriff auf sensible eigene Felder erfordert die Berechtigung sensitive.
  • Ergebnisse anonymer Umfragen gibt es nur als Summen. Sie sind nicht verfügbar, solange die Antworten versiegelt sind oder es zu wenige gibt, um die Anonymität der Teilnehmenden zu schützen.
  • Das API-Protokoll speichert Schlüssel, Endpunkt, Antwortstatus und Dauer 30 Tage lang, ohne Inhalt von Anfrage oder Antwort. Die letzten Aufrufe finden Sie unter Zugriff → API-Schlüssel.

KPI-Werte senden

Systeme, die nur KPI-Werte senden (Umsätze, Bewertungen, Zählungen), können das über fachliche Referenzen statt IDs tun: POST /api/v1/metrics/{key}/values mit einem Zeitraum und den Werten für Mitarbeiter (über die Personalnummer), Standorte oder Abteilungen (über das Kürzel). Erfordert die Berechtigung metrics:write; GET /api/v1/metrics listet die Kennzahlen, die Werte annehmen.

POST https://compania-mea.pulsika.eu/api/v1/metrics/sales.actual/values

{
    "period": "2026-09",
    "values": [
        {
            "subject": "CJ01",
            "value": 1234.5
        },
        {
            "subject": "FV0012",
            "value": 980
        }
    ]
}

Organisation

Gebiete /geo-areas

Der Baum aus Ländern, Regionen und Zonen, zu denen die Standorte gehören; er bestimmt auch den Zuständigkeitsbereich der Gebietsleitungen. Namen sind unter Geschwistern eindeutig. Das Löschen wird abgelehnt, solange Standorte oder Untergebiete es verwenden.

Berechtigungen: geo_areas:read, geo_areas:write

Endpunkte

  • GET /api/v1/geo-areas Liste
  • GET /api/v1/geo-areas/{id} Ein Eintrag
  • POST /api/v1/geo-areas Anlegen
  • PATCH /api/v1/geo-areas/{id} Ändern
  • DELETE /api/v1/geo-areas/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name, eindeutig unter den Gebieten mit demselben übergeordneten Gebiet.
level_labelstring | null Wie diese Ebene heißt (Land, Region, Zone).
parent_idinteger | null Das Gebiet, in dem es liegt; null für ein oberstes Gebiet. Nie es selbst oder eines seiner Untergebiete.
sortinteger | null Reihenfolge unter seinen Geschwistern.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

parent_idintegerNur die Gebiete direkt unter diesem.
rootsbooleantrue: nur die obersten Gebiete.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/geo-areas

{
    "name": "Nord-Vest",
    "level_label": "regiune",
    "parent_id": 1,
    "sort": 0
}

Beispielantwort

{
    "data": {
        "id": 3,
        "name": "Nord-Vest",
        "level_label": "regiune",
        "parent_id": 1,
        "sort": 0,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Standorte /work-units

Die Standorte des Unternehmens: Filialen, Apotheken, Büros, Hotels. Das Löschen wird abgelehnt, solange noch Personen, Dokumente oder Ergebnisse darauf verweisen.

Berechtigungen: work_units:read, work_units:write

Endpunkte

  • GET /api/v1/work-units Liste
  • GET /api/v1/work-units/{id} Ein Eintrag
  • POST /api/v1/work-units Anlegen
  • PATCH /api/v1/work-units/{id} Ändern
  • DELETE /api/v1/work-units/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name, eindeutig im Unternehmen.
codestring | null Ihr eigenes Kürzel, eindeutig im Unternehmen (zur Zuordnung von KPI-Werten).
geo_area_idinteger | null Das Gebiet (Region, Land), zu dem er gehört.
addressstring | null Straße und Hausnummer.
citystring | nullnur lesbar Ort (aus der amtlichen Liste bei rumänischen Standorten).
countystring | nullnur lesbar Kreis oder Region.
phonestring | null Telefon.
emailstring | null E-Mail.
opened_ondate | null Eröffnungsdatum.
closed_ondate | null Schließungsdatum.
is_activeboolean Ob er in Verwendung ist.
custom_fieldsobject Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

codestringGenaues Kürzel (ohne Beachtung der Groß-/Kleinschreibung).
geo_area_idintegerNur in diesem Gebiet.
is_activebooleantrue oder false.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/work-units

{
    "name": "Farmacia Verde Centru",
    "code": "CJ01",
    "geo_area_id": 3,
    "address": "Str. Memorandumului 10",
    "opened_on": "2016-03-01",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Beispielantwort

{
    "data": {
        "id": 12,
        "name": "Farmacia Verde Centru",
        "code": "CJ01",
        "geo_area_id": 3,
        "address": "Str. Memorandumului 10",
        "city": "Cluj-Napoca",
        "county": "Cluj",
        "phone": null,
        "email": null,
        "opened_on": "2016-03-01",
        "closed_on": "2026-05-01",
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Abteilungen /departments

Unternehmensweite Bereiche (Vertrieb, Logistik …), die verschachtelt werden können. Das Löschen wird abgelehnt, solange Zuordnungen oder Unterabteilungen sie verwenden.

Berechtigungen: departments:read, departments:write

Endpunkte

  • GET /api/v1/departments Liste
  • GET /api/v1/departments/{id} Ein Eintrag
  • POST /api/v1/departments Anlegen
  • PATCH /api/v1/departments/{id} Ändern
  • DELETE /api/v1/departments/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name, eindeutig im Unternehmen.
codestring | null Ihr eigenes Kürzel, eindeutig im Unternehmen (zur Zuordnung von KPI-Werten).
parent_idinteger | null Die Abteilung, zu der sie gehört; nie sie selbst oder eine ihrer Unterabteilungen.
is_activeboolean Ob sie in Verwendung ist.
custom_fieldsobject Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

codestringGenaues Kürzel (ohne Beachtung der Groß-/Kleinschreibung).
parent_idintegerNur die Abteilungen direkt unter dieser.
is_activebooleantrue oder false.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/departments

{
    "name": "Farmacie",
    "code": "FARM",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Beispielantwort

{
    "data": {
        "id": 4,
        "name": "Farmacie",
        "code": "FARM",
        "parent_id": 1,
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Positionen /positions

Stellen und ihre Stufe (eine höhere Zahl ist eine höhere Position). Das Löschen wird abgelehnt, solange jemand sie innehat.

Berechtigungen: positions:read, positions:write

Endpunkte

  • GET /api/v1/positions Liste
  • GET /api/v1/positions/{id} Ein Eintrag
  • POST /api/v1/positions Anlegen
  • PATCH /api/v1/positions/{id} Ändern
  • DELETE /api/v1/positions/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name, eindeutig im Unternehmen.
codestring | null Ihr eigenes Kürzel, eindeutig im Unternehmen.
levelintegererforderlich Hierarchiestufe, von 0 bis 100.
descriptiontext | null Beschreibung.
is_activeboolean Ob sie in Verwendung ist.
custom_fieldsobject Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

codestringGenaues Kürzel (ohne Beachtung der Groß-/Kleinschreibung).
is_activebooleantrue oder false.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/positions

{
    "name": "Farmacist",
    "code": "FA",
    "level": 2,
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Beispielantwort

{
    "data": {
        "id": 7,
        "name": "Farmacist",
        "code": "FA",
        "level": 2,
        "description": null,
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Teams /teams

Gruppen von Personen über Standorte hinweg (ein Projekt, eine Arbeitsgruppe). Mitglieder werden einzeln mit den Aktionen unten hinzugefügt und entfernt.

Berechtigungen: teams:read, teams:write

Endpunkte

  • GET /api/v1/teams Liste
  • GET /api/v1/teams/{id} Ein Eintrag
  • POST /api/v1/teams Anlegen
  • PATCH /api/v1/teams/{id} Ändern
  • DELETE /api/v1/teams/{id} Löschen
  • POST /api/v1/teams/{id}/add-member Fügt einen Mitarbeiter zum Team hinzu (nichts ändert sich, wenn sie schon dabei ist). Inhalt: {"employee_id": 345}.
  • POST /api/v1/teams/{id}/remove-member Entfernt einen Mitarbeiter aus dem Team. Inhalt: {"employee_id": 345}.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name, eindeutig im Unternehmen.
descriptiontext | null Beschreibung.
is_activeboolean Ob es in Verwendung ist.
member_idsarraynur lesbar Die Mitarbeiter im Team (nur lesbar; ändern Sie sie mit add-member / remove-member).
custom_fieldsobject Die eigenen Felder des Unternehmens, nach Feld-ID (siehe /custom-fields).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue oder false.
employee_idintegerNur die Teams, in denen diese Person ist.

/api/v1/teams/{id}/add-member: employee_id (integer) — Die hinzuzufügende Person (eine ID aus /employees).

/api/v1/teams/{id}/remove-member: employee_id (integer) — Die zu entfernende Person (eine ID aus /employees).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/teams

{
    "name": "Proiect inventar",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Beispielantwort

{
    "data": {
        "id": 2,
        "name": "Proiect inventar",
        "description": null,
        "is_active": true,
        "member_ids": [
            345,
            346
        ],
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Eigene Felder /custom-fields

Die Felder, die das Unternehmen seinen eigenen Einträgen hinzugefügt hat, nur lesbar: was jede ID in den custom_fields eines Eintrags bedeutet, ihr Typ und ihre Auswahlen. Sensible Felder zu Mitarbeitern werden nur für einen Schlüssel mit der Berechtigung sensitive aufgeführt. Die Felder werden in der Anwendung festgelegt.

Berechtigungen: custom_fields:read

Endpunkte

  • GET /api/v1/custom-fields Liste
  • GET /api/v1/custom-fields/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung; der Schlüssel in den custom_fields eines Eintrags.
entityemployee | work_unit | department | position | team | companynur lesbar Die Art von Eintrag, zu der es gehört.
labelstringnur lesbar Sein Name, in der Sprache der Anfrage (Accept-Language).
typetext | textarea | number | date | boolean | select | multiselect | urlnur lesbar Was es enthält: text, textarea, number, date (Y-m-d), boolean, select, multiselect oder url.
optionsarray | nullnur lesbar Die Auswahlen eines select oder multiselect: id und label; gespeichert wird die id.
is_requiredbooleannur lesbar Ob ein Wert erforderlich ist.
visibilityreach | sensitivenur lesbar reach (alle, die die Person sehen) oder sensitive.
is_activebooleannur lesbar Ob es in Verwendung ist.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

entityemployee | work_unit | department | position | team | companyNur die Felder dieser Art von Eintrag.
is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 12,
        "entity": "employee",
        "label": "Mărime uniformă",
        "type": "select",
        "options": [
            {
                "id": "m",
                "label": "M"
            }
        ],
        "is_required": false,
        "visibility": "reach",
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Personal und Zeit

Mitarbeiter /employees

Die Personen des Unternehmens. Beim Anlegen entsteht auch ihre erste Zuordnung; spätere Wechsel laufen über /placements. Persönliche Kennnummern (Steuer-ID, Sozialversicherungsnummer, die rumänische CNP) werden über die API nie gelesen oder geschrieben. Konten werden in der Anwendung angelegt.

Berechtigungen: employees:read, employees:write

Endpunkte

  • GET /api/v1/employees Liste
  • GET /api/v1/employees/{id} Ein Eintrag
  • POST /api/v1/employees Anlegen
  • PATCH /api/v1/employees/{id} Ändern
  • DELETE /api/v1/employees/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
employee_numberstring | null Ihre Personalnummer, eindeutig im Unternehmen (zur Zuordnung von KPI-Werten).
first_namestringerforderlich Vorname.
last_namestringerforderlich Nachname.
emailstring | null Dienstliche E-Mail.
phonestring | null Telefon.
birth_datedate | null Geburtsdatum.
hire_datedate | null Eintrittsdatum (die erste Zuordnung beginnt an diesem Tag).
termination_datedate | null Austrittsdatum.
statusactive | inactive | terminated active, inactive oder terminated.
work_unit_idintegererforderlich Standort der aktuellen Hauptzuordnung; beim Anlegen erforderlich, danach nur lesbar.
department_idinteger | null Abteilung der aktuellen Hauptzuordnung (nur beim Anlegen).
position_idinteger | null Position der aktuellen Hauptzuordnung (nur beim Anlegen).
has_loginbooleannur lesbar Ob sich die Person anmelden kann.
custom_fieldsobject Die eigenen Felder des Unternehmens, nach Feld-ID; sensible nur mit der Berechtigung sensitive.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusactive | inactive | terminatedNur mit diesem Status.
work_unit_idintegerDerzeit diesem Standort zugeordnet.
employee_numberstringGenaue Personalnummer.
emailstringGenaue E-Mail.
qstringTeil des Namens.
hired_sincedateEingestellt ab diesem Datum (Y-m-d): neue Mitarbeitende.
leaving_sincedateAustritt ab diesem Datum (Y-m-d): ein Austrittsdatum ist gesetzt.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/employees

{
    "employee_number": "FV0012",
    "first_name": "Ana",
    "last_name": "Popescu",
    "email": "ana.popescu@example.com",
    "hire_date": "2024-02-01",
    "status": "active",
    "work_unit_id": 12,
    "custom_fields": {
        "12": "XL"
    }
}

Beispielantwort

{
    "data": {
        "id": 345,
        "employee_number": "FV0012",
        "first_name": "Ana",
        "last_name": "Popescu",
        "email": "ana.popescu@example.com",
        "phone": null,
        "birth_date": "2026-05-01",
        "hire_date": "2024-02-01",
        "termination_date": "2026-05-01",
        "status": "active",
        "work_unit_id": 12,
        "department_id": 1,
        "position_id": 1,
        "has_login": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zuordnungen /placements

Wo jede Person arbeitet: Standort, Abteilung und Position, von wann bis wann. Eine neue Hauptzuordnung löst die vorherige ab, die als aktuelle Nebenzuordnung bleibt, bis sie beendet wird.

Berechtigungen: placements:read, placements:write

Endpunkte

  • GET /api/v1/placements Liste
  • GET /api/v1/placements/{id} Ein Eintrag
  • POST /api/v1/placements Anlegen
  • DELETE /api/v1/placements/{id} Löschen
  • POST /api/v1/placements/{id}/end Beendet die Zuordnung am valid_to (nicht vor ihrem Beginn).
  • POST /api/v1/placements/{id}/make-primary Macht sie zur Hauptzuordnung der Person; die bisherige Hauptzuordnung wird zur Nebenzuordnung.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
employee_idintegererforderlich Die Person.
work_unit_idintegererforderlich Der Standort.
department_idinteger | null Die Abteilung.
position_idinteger | null Die Position.
is_primaryboolean Ob es die Hauptzuordnung der Person ist.
valid_fromdateerforderlich Erster Tag.
valid_todate | null Letzter Tag (leer: noch aktuell).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

employee_idintegerNur die dieser Person.
work_unit_idintegerNur an diesem Standort.
currentbooleantrue: nur heute gültige Zuordnungen.

/api/v1/placements/{id}/end: valid_to (date) — Der letzte Tag der Zuordnung (Y-m-d).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/placements

{
    "employee_id": 345,
    "work_unit_id": 12,
    "is_primary": true,
    "valid_from": "2026-03-01"
}

Beispielantwort

{
    "data": {
        "id": 901,
        "employee_id": 345,
        "work_unit_id": 12,
        "department_id": 1,
        "position_id": 1,
        "is_primary": true,
        "valid_from": "2026-03-01",
        "valid_to": "2026-05-01",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Abwesenheitsarten /leave-types

Die Abwesenheitsarten, die das Unternehmen verwendet, wie in der Anwendung eingerichtet. Nur lesbar.

Berechtigungen: leave_types:read

Endpunkte

  • GET /api/v1/leave-types Liste
  • GET /api/v1/leave-types/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
codestring | nullnur lesbar Kurzes Kürzel.
namestringnur lesbar Name, in der Sprache der Anfrage (Accept-Language), ersatzweise in der des Unternehmens.
uses_balancebooleannur lesbar Ob die Tage von einem Jahresurlaubskonto abgehen.
default_entitlementnumber | nullnur lesbar Tage pro Jahr bei ganzjähriger Beschäftigung.
is_paidbooleannur lesbar Bezahlte Abwesenheit.
requires_attachmentbooleannur lesbar Ein Dokument muss angehängt werden (Anträge, die eines brauchen, werden in der Anwendung gestellt).
requires_referencebooleannur lesbar Eine Referenznummer ist erforderlich.
requires_replacementbooleannur lesbar Eine Vertretung ist erforderlich.
is_activebooleannur lesbar Ob sie beantragt werden kann.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 1,
        "code": "CO",
        "name": "Concediu de odihnă",
        "uses_balance": true,
        "default_entitlement": 21,
        "is_paid": true,
        "requires_attachment": true,
        "requires_reference": true,
        "requires_replacement": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Abwesenheitsanträge /leave-requests

Abwesenheitsanträge, nach denselben Regeln wie in der Anwendung: Die Arbeitstage werden gezählt, Urlaubskonto und Überschneidungen geprüft, und der Genehmigungsablauf des Unternehmens beginnt. Genehmigen und Ablehnen folgen dem Ablauf des Antrags: Die Person, die den Schlüssel angelegt hat, muss im aktuellen Schritt genehmigen dürfen.

Berechtigungen: leave_requests:read, leave_requests:write

Endpunkte

  • GET /api/v1/leave-requests Liste
  • GET /api/v1/leave-requests/{id} Ein Eintrag
  • POST /api/v1/leave-requests Anlegen
  • POST /api/v1/leave-requests/{id}/approve Genehmigt den aktuellen Schritt (Kommentar optional).
  • POST /api/v1/leave-requests/{id}/reject Lehnt den Antrag ab; Kommentar (der Grund) erforderlich.
  • POST /api/v1/leave-requests/{id}/cancel Storniert einen offenen oder genehmigten Antrag.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
employee_idintegererforderlich Die abwesende Person.
leave_type_idintegererforderlich Die Abwesenheitsart.
starts_ondateerforderlich Erster Tag.
ends_ondateerforderlich Letzter Tag.
half_startboolean Der erste Tag ist nur nachmittags (zählt als halber Tag).
half_endboolean Der letzte Tag ist nur vormittags (zählt als halber Tag).
daysnumbernur lesbar Gezählte Tage (Arbeitstage ohne Feiertage; halbe Tage zählen 0,5).
hoursnumber | null Bei einer in Stunden gezählten Art: die Stunden, die sie umfasst (die Stunden ihrer Tage laut Arbeitszeitmodell der Person). Beim Anlegen: ein Teil eines eintägigen Antrags.
for_childboolean Für ein erkranktes Kind beantragt (eine Art, die dafür eine weitere Woche erlaubt).
statuspending | approved | rejected | cancellednur lesbar pending, approved, rejected oder cancelled.
replacement_employee_idinteger | null Die vertretende Person.
referencestring | null Referenznummer (zum Beispiel einer Arbeitsunfähigkeitsbescheinigung).
notetext | null Anmerkung.
has_certificateyes | no | pending | null Gesundheitsbezogene Abwesenheit: ob eine ärztliche Bescheinigung vorliegt (yes / no / pending); nur mit dem Bereich für sensible Daten.
certificate_fromdate | null Erster Tag der Bescheinigung (wo das Land ihn erfasst).
certificate_untildate | null Letzter Tag der Bescheinigung.
eau_statusnot_retrieved | retrieved | confirmed | nullnur lesbar Deutschland: ob die eAU bei der Krankenkasse abgerufen wurde.
created_atdatetimenur lesbar Gestellt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

employee_idintegerNur die dieser Person.
statuspending | approved | rejected | cancelledNur mit diesem Status.
fromdateBerührt diesen Tag oder später.
todateBerührt diesen Tag oder früher.

/api/v1/leave-requests/{id}/approve: comment (text) — Optionaler Kommentar für die Person.

/api/v1/leave-requests/{id}/reject: comment (text) — Der Grund, der Person angezeigt (erforderlich).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/leave-requests

{
    "employee_id": 345,
    "leave_type_id": 1,
    "starts_on": "2026-07-06",
    "ends_on": "2026-07-10",
    "half_start": false,
    "half_end": false,
    "for_child": false
}

Beispielantwort

{
    "data": {
        "id": 77,
        "employee_id": 345,
        "leave_type_id": 1,
        "starts_on": "2026-07-06",
        "ends_on": "2026-07-10",
        "half_start": false,
        "half_end": false,
        "days": 5,
        "hours": 12.5,
        "for_child": false,
        "status": "pending",
        "replacement_employee_id": 1,
        "reference": null,
        "note": null,
        "has_certificate": "yes",
        "certificate_from": "2026-05-01",
        "certificate_until": "2026-05-01",
        "eau_status": "not_retrieved",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Urlaubskonten /leave-balances

Das Jahreskonto jeder Person pro Abwesenheitsart mit Tageszählung. Beim Auflisten eines Jahres wird es für jede aktive Person eröffnet, anteilig und mit Übertrag, wie in der Anwendung; genommen, beantragt und verfügbar werden berechnet. Anspruch, Korrektur und Übertrag können geändert werden – nie beim eigenen Datensatz der Person, die den Schlüssel angelegt hat.

Berechtigungen: leave_balances:read, leave_balances:write

Endpunkte

  • GET /api/v1/leave-balances Liste
  • GET /api/v1/leave-balances/{id} Ein Eintrag
  • PATCH /api/v1/leave-balances/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
employee_idintegernur lesbar Die Person.
leave_type_idintegernur lesbar Die Abwesenheitsart.
yearintegernur lesbar Das Jahr.
entitlementnumber Tage für das Jahr (0–365).
adjustmentnumber Hinzugefügte oder abgezogene Tage (−365–365).
carried_overnumber Aus dem Vorjahr übertragene Tage.
carried_over_expires_ondate | null Bis wann die übertragenen Tage genutzt werden können.
carried_usablenumbernur lesbar Heute noch nutzbare übertragene Tage.
earliernumbernur lesbar Noch verbleibende Tage aus den Jahren vor dem Vorjahr, heute nutzbar.
earlier_expires_ondate | nullnur lesbar Bis wann die frühesten dieser Tage genommen werden können.
usednumbernur lesbar Genommene Tage (genehmigt).
pendingnumbernur lesbar Beantragte Tage, die auf Genehmigung warten.
availablenumbernur lesbar Verbleibende Tage.
notestring | null Anmerkung.
created_atdatetimenur lesbar Eröffnet.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

yearintegerDas Jahr (Standard: dieses Jahr).
employee_idintegerNur diese Person.
leave_type_idintegerNur diese Abwesenheitsart.

Beispielantwort

{
    "data": {
        "id": 55,
        "employee_id": 345,
        "leave_type_id": 1,
        "year": 2026,
        "entitlement": 21,
        "adjustment": 0,
        "carried_over": 3,
        "carried_over_expires_on": "2026-03-31",
        "carried_usable": 3,
        "earlier": 0,
        "earlier_expires_on": "2026-05-01",
        "used": 5,
        "pending": 2,
        "available": 17,
        "note": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kalendertermine /calendar-events

Der Kalender des Unternehmens. Teilnehmende (oder der Standort) werden über einen neuen Termin, eine neue Uhrzeit oder einen neuen Ort benachrichtigt. Ein neuer Termin kann sich wiederholen: Jede Wiederholung wird ein eigener Termin in einer Serie und wird einzeln geändert, abgesagt oder gelöscht.

Berechtigungen: calendar_events:read, calendar_events:write

Endpunkte

  • GET /api/v1/calendar-events Liste
  • GET /api/v1/calendar-events/{id} Ein Eintrag
  • POST /api/v1/calendar-events Anlegen
  • PATCH /api/v1/calendar-events/{id} Ändern
  • DELETE /api/v1/calendar-events/{id} Löschen
  • POST /api/v1/calendar-events/{id}/cancel Sagt diese Wiederholung ab; die Teilnehmenden werden informiert.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
event_type_idinteger | null Terminart.
titlestringerforderlich Titel.
descriptiontext | null Beschreibung (HTML; bereinigt wie jeder in der Anwendung geschriebene Text).
locationstring | null Ort.
starts_atdatetimeerforderlich Beginn (ISO 8601).
ends_atdatetimeerforderlich Ende (ISO 8601).
all_dayboolean Ganztägig.
visibilityeveryone | unit | participantserforderlich everyone, unit (die Personen des Standorts) oder participants.
work_unit_idinteger | null Der Standort, bei visibility unit.
participantsarray IDs der eingeladenen Mitarbeiter.
rsvpboolean Fragt, wer kommt.
recurrenceweekly | biweekly | monthly | yearly | null Nur beim Anlegen: weekly, biweekly, monthly oder yearly.
recurrence_untildate | null Nur beim Anlegen: der letzte Tag der Serie (höchstens zwei Jahre im Voraus).
series_idinteger | nullnur lesbar Die Serie, zu der er gehört.
cancelled_atdatetime | nullnur lesbar Wann er abgesagt wurde.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

fromdateEndet an diesem Tag oder später.
todateBeginnt an diesem Tag oder früher.
work_unit_idintegerNur die dieses Standorts.
cancelledbooleantrue: nur abgesagte; false: nur die übrigen.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/calendar-events

{
    "title": "Inventar trimestrial",
    "description": "<p>Toată echipa.</p>",
    "starts_at": "2026-07-06T15:00:00Z",
    "ends_at": "2026-07-06T17:00:00Z",
    "visibility": "everyone",
    "participants": [
        345,
        346
    ]
}

Beispielantwort

{
    "data": {
        "id": 410,
        "event_type_id": 1,
        "title": "Inventar trimestrial",
        "description": "<p>Toată echipa.</p>",
        "location": null,
        "starts_at": "2026-07-06T15:00:00Z",
        "ends_at": "2026-07-06T17:00:00Z",
        "all_day": true,
        "visibility": "everyone",
        "work_unit_id": 1,
        "participants": [
            345,
            346
        ],
        "rsvp": true,
        "recurrence": "weekly",
        "recurrence_until": "2026-05-01",
        "series_id": 1,
        "cancelled_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Performance

KPI-Kennzahlen /kpi-metrics

Was das Unternehmen misst: Schlüssel und Einheit jeder Kennzahl, für welche Subjekte sie gemessen wird (grain) und wie oft (period). Nur lesbar; Kennzahlen werden in der Anwendung festgelegt. Werte können über die API nur an Kennzahlen mit der Quelle „api“ gesendet werden.

Berechtigungen: kpi_metrics:read

Endpunkte

  • GET /api/v1/kpi-metrics Liste
  • GET /api/v1/kpi-metrics/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
keystringnur lesbar Der Schlüssel der Kennzahl, verwendet in Formeln und beim Senden von Werten.
labelstringnur lesbar Name, in der Sprache des Unternehmens.
descriptionstring | nullnur lesbar Was sie misst.
unitcurrency | percent | count | score | days | hours | rationur lesbar Einheit: currency, percent, count, score, days, hours oder ratio.
value_typedecimal | integer | percent | booleannur lesbar Art des Werts: decimal, integer, percent oder boolean.
grainemployee | team | department | work_unit | geo_area | companynur lesbar Für wen sie gemessen wird: employee, team, department, work_unit, geo_area oder company.
periodday | week | month | quarter | yearnur lesbar Wie oft: day, week, month, quarter oder year.
aggregationsum | avg | last | min | max | countnur lesbar Wie sich Werte über einen längeren Zeitraum zusammenfassen.
source_typemanual | import | module | derived | api | objective | reviewnur lesbar Woher ihre Werte kommen (manual, import, api, ein Modul …).
is_higher_betterbooleannur lesbar Ob ein höherer Wert besser ist.
is_activebooleannur lesbar Ob sie in Verwendung ist.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

keystringGenauer Schlüssel (ohne Beachtung der Groß-/Kleinschreibung).
source_typemanual | import | module | derived | api | objective | reviewNur Kennzahlen mit dieser Quelle.
is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 7,
        "key": "sales.actual",
        "label": "Sales",
        "description": null,
        "unit": "currency",
        "value_type": "decimal",
        "grain": "employee",
        "period": "month",
        "aggregation": "sum",
        "source_type": "api",
        "is_higher_better": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

KPI-Werte /metric-values

Der Wert einer Kennzahl für ein Subjekt in einem Zeitraum. Beim Anlegen wird er geschrieben (oder ersetzt den bereits vorhandenen Wert für dieses Subjekt und diesen Zeitraum); nur Kennzahlen mit der Quelle „api“ nehmen Werte an. Ein fehlender Wert (null) bedeutet „keine Daten“, nie null. Um viele Werte über fachliche Referenzen (Personalnummer, Standortkürzel) zu senden, verwenden Sie POST /metrics/{key}/values.

Berechtigungen: metric_values:read, metric_values:write

Endpunkte

  • GET /api/v1/metric-values Liste
  • GET /api/v1/metric-values/{id} Ein Eintrag
  • POST /api/v1/metric-values Anlegen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
metricstringerforderlich Der Schlüssel der Kennzahl.
subject_typeemployee | team | department | work_unit | geo_area | companynur lesbar Die Art des Subjekts (das grain der Kennzahl).
subject_idintegererforderlich Die ID des Subjekts (eine ID von Person, Standort, Abteilung, Gebiet oder Team; 0 für das Unternehmen).
periodstringerforderlich Der Schlüssel des Zeitraums: 2026-09 (Monat), 2026-W38 (Woche), 2026-Q3, 2026, 2026-09-14 (Tag).
period_startdatenur lesbar Erster Tag des Zeitraums.
period_enddatenur lesbar Letzter Tag des Zeitraums.
valuescalar | null Der Wert, als Zahl oder Text („1234.5“, „1.234,5“, „87%“, true/false); null für keine Daten. Gespeichert als Dezimalzeichenkette.
sourcemanual | import | module | derived | api | objective | reviewnur lesbar Woher er kam.
recorded_atdatetimenur lesbar Wann er geschrieben wurde.

Filter

metricstringNur die Werte dieser Kennzahl (ihr Schlüssel).
periodstringNur dieser Zeitraum (erfordert metric).
subject_idintegerNur dieses Subjekt.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/metric-values

{
    "metric": "sales.api",
    "subject_id": 345,
    "period": "2026-09",
    "value": "1234.5"
}

Beispielantwort

{
    "data": {
        "id": 5120,
        "metric": "sales.api",
        "subject_type": "employee",
        "subject_id": 345,
        "period": "2026-09",
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "value": "1234.5",
        "source": "api",
        "recorded_at": "2026-05-01T08:00:00Z"
    }
}

KPI-Scorecards /kpi-scorecards

KPI-Scorecards und alle ihre Versionen (Entwurf, veröffentlicht, archiviert): die Teile, aus denen ein Score besteht, ihre Gewichtungen und die Stufen, in die ein Score fällt. Nur lesbar; KPI-Scorecards werden in der Anwendung gebaut, und eine veröffentlichte Version ändert sich nie.

Berechtigungen: kpi_scorecards:read

Endpunkte

  • GET /api/v1/kpi-scorecards Liste
  • GET /api/v1/kpi-scorecards/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung dieser Version.
familystringnur lesbar Die KPI-Scorecard über ihre Versionen hinweg.
versionintegernur lesbar Versionsnummer.
namestringnur lesbar Name.
descriptionstring | nullnur lesbar Beschreibung.
grainemployee | team | department | work_unit | geo_area | companynur lesbar Wen sie bewertet.
periodday | week | month | quarter | yearnur lesbar Wie oft sie bewertet.
statusdraft | published | archivednur lesbar draft, published oder archived.
effective_fromdate | nullnur lesbar Gültig ab.
effective_todate | nullnur lesbar Gültig bis.
published_atdatetime | nullnur lesbar Wann diese Version veröffentlicht wurde.
componentsarraynur lesbar Ihre Teile: key, label, Gewichtung (0–1), Zielwert, Anzeigeformat, ob die Person ihn sieht.
levelsarraynur lesbar Ihre Stufen: Name, der niedrigste Score, der sie erreicht, Farbe.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusdraft | published | archivedNur Versionen mit diesem Status.
familystringNur die Versionen dieser KPI-Scorecard.

Beispielantwort

{
    "data": {
        "id": 4,
        "family": "9b2e0c1e-0f0a-4b47-9f3a-2c1d7e8a1b20",
        "version": 2,
        "name": "Pharmacist performance",
        "description": null,
        "grain": "employee",
        "period": "month",
        "status": "published",
        "effective_from": "2026-05-01",
        "effective_to": "2026-05-01",
        "published_at": "2026-05-01T08:00:00Z",
        "components": [
            {
                "key": "sales",
                "label": "Sales achievement",
                "weight": "0.55"
            }
        ],
        "levels": [
            {
                "name": "Good",
                "min_score": "85",
                "color": "#2B6CB0"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

KPI-Ergebnisse /kpi-results

Scores auf den KPI-Scorecards: das aktuelle Ergebnis jedes Subjekts und Zeitraums, die erreichte Stufe sowie Wert und Punkte jedes Teils. Eine Gesamtwertung oder ein Teil ohne Daten ist null, nie 0. Nur lesbar; Ergebnisse entstehen beim Abschluss eines Zeitraums.

Berechtigungen: kpi_results:read

Endpunkte

  • GET /api/v1/kpi-results Liste
  • GET /api/v1/kpi-results/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
scorecard_idintegernur lesbar Die Version der KPI-Scorecard, die bewertet hat.
scorecardstringnur lesbar Ihr Name.
subject_typeemployee | team | department | work_unit | geo_area | companynur lesbar Die Art des Subjekts.
subject_idintegernur lesbar Die ID des Subjekts.
subjectstring | nullnur lesbar Der Name des Subjekts.
perioddatenur lesbar Erster Tag des Zeitraums.
totalstring | nullnur lesbar Der Score als Dezimalzeichenkette; null, wenn es keine Daten gibt.
levelstring | nullnur lesbar Die erreichte Stufe.
level_colorstring | nullnur lesbar Die Farbe der Stufe.
bonusstring | nullnur lesbar Der Bonus, falls die KPI-Scorecard einen berechnet.
partsarraynur lesbar Jeder Teil: key, label, Wert und die Punkte, die er bringt (Dezimalzeichenketten; null für keine Daten).
created_atdatetimenur lesbar Wann er berechnet wurde.

Filter

scorecard_idintegerNur diese Version der KPI-Scorecard.
perioddateErster Tag des Zeitraums (Y-m-d).
subject_typeemployee | team | department | work_unit | geo_area | companyNur diese Art von Subjekt.
subject_idintegerNur dieses Subjekt.

Beispielantwort

{
    "data": {
        "id": 9811,
        "scorecard_id": 4,
        "scorecard": "Pharmacist performance",
        "subject_type": "employee",
        "subject_id": 345,
        "subject": "Ana Popescu",
        "period": "2026-09-01",
        "total": "92.40",
        "level": "Good",
        "level_color": "#2B6CB0",
        "bonus": null,
        "parts": [
            {
                "key": "sales",
                "label": "Sales achievement",
                "value": "104.2",
                "points": "57.31"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z"
    }
}

Prioritäten /priorities

Wohin das Unternehmen, ein Gebiet, ein Standort, eine Abteilung oder eine Person in einem Zeitraum steuert, und die Schlüsselergebnisse, an denen es gemessen wird, mit dem Stand jedes einzelnen (Fortschritt in Prozent und wo es heute stehen sollte). Nur lesen, dazu die Aktion move für von Hand verfolgte Schlüsselergebnisse; ein Schlüsselergebnis, das eine KPI-Kennzahl liest, bewegt sich mit ihren Daten. Entwürfe erscheinen nie.

Berechtigungen: priorities:read, priorities:write

Endpunkte

  • GET /api/v1/priorities Liste
  • GET /api/v1/priorities/{id} Ein Eintrag
  • POST /api/v1/priorities/{id}/move Ein von Hand verfolgtes Schlüsselergebnis bewegen: ein neuer Wert für eine Zahl, erreicht oder nicht für einen Schritt, mit optionaler Notiz.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
parent_idinteger | nullnur lesbar Die Priorität, an der sie sich ausrichtet.
levelcompany | geo_area | work_unit | department | personnur lesbar company, geo_area, work_unit, department oder person.
subject_idintegernur lesbar Für wen: das Gebiet, der Standort, die Abteilung oder die Person (0 für das Unternehmen).
owner_idinteger | nullnur lesbar Das verantwortliche Konto.
titlestringnur lesbar Was erreicht werden soll.
descriptiontext | nullnur lesbar Warum es wichtig ist.
period_typemonth | quarter | yearnur lesbar month, quarter oder year.
period_startdatenur lesbar Erster Tag des Zeitraums.
period_enddatenur lesbar Letzter Tag.
statusactive | closed | cancellednur lesbar active, closed oder cancelled.
progressnumber | nullnur lesbar Der Stand in Prozent (null = noch keine Daten).
expectednumbernur lesbar Wo es heute stehen sollte, in Prozent.
key_resultsarraynur lesbar Jedes Schlüsselergebnis: Art (manual, milestone, metric), Titel, Einheit, Start- und Zielwert, aktueller Wert, Fortschritt und die gelesene KPI-Kennzahl.
created_atdatetimenur lesbar Erstellt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

levelcompany | geo_area | work_unit | department | personNur diese Ebene.
statusactive | closed | cancelledNur dieser Status.
ondateNur Prioritäten, die an diesem Tag laufen (Y-m-d).

/api/v1/priorities/{id}/move: key_result_id (integer) — Das Schlüsselergebnis dieser Priorität.; value (number) — Der neue Wert (ein Zahlen-Schlüsselergebnis).; done (boolean) — Erreicht oder nicht (ein Schritt).; note (string) — Warum es sich bewegt hat.

Beispielantwort

{
    "data": {
        "id": 1,
        "parent_id": 1,
        "level": "company",
        "subject_id": 12,
        "owner_id": 1,
        "title": "text",
        "description": null,
        "period_type": "month",
        "period_start": "2026-05-01",
        "period_end": "2026-05-01",
        "status": "active",
        "progress": "62.5",
        "expected": "48.9",
        "key_results": [
            {
                "id": 7,
                "kind": "manual",
                "title": "Units taking online orders",
                "unit": null,
                "start_value": "0",
                "target_value": "12",
                "current": "7",
                "progress": "58.3",
                "metric_key": null
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ziele /objectives

Ziele unter einer Regel (zum Beispiel „Fokusprodukte“): Zeitraum, Parameter und Zielwerte pro Standort. Regel und Zeitraum sind nach dem Anlegen fest. Die Aktion record speichert, was Personen oder Standorte erreicht haben; bewertet wird beim Bewerten des Zeitraums. Ein bereits bewertetes Ziel kann nicht gelöscht werden.

Berechtigungen: objectives:read, objectives:write

Endpunkte

  • GET /api/v1/objectives Liste
  • GET /api/v1/objectives/{id} Ein Eintrag
  • POST /api/v1/objectives Anlegen
  • PATCH /api/v1/objectives/{id} Ändern
  • DELETE /api/v1/objectives/{id} Löschen
  • POST /api/v1/objectives/{id}/record Erfasst, was Subjekte erreicht haben: Ihre Messwerte ersetzen das bisher Erfasste; leere Messwerte verwerfen es (wieder keine Daten).

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
rule_idintegererforderlich Die Regel, die es bewertet (nur beim Anlegen).
rulestringnur lesbar Der Name der Regel.
namestringerforderlich Name.
descriptiontext | null Beschreibung.
periodstringerforderlich Der Schlüssel des Zeitraums im Zeitraum der Regel (nur beim Anlegen), zum Beispiel 2026-09.
period_startdatenur lesbar Erster Tag.
period_enddatenur lesbar Letzter Tag.
paramsobject Werte für die Parameter der Regel, nach Name (andere werden ignoriert); weggelassen: die Standardwerte der Regel.
targetsarray Zielwerte pro Standort: eine Liste von {work_unit_id, target}. Gibt es Zielwerte, gilt das Ziel nur für diese Standorte.
external_refstring | null Ihre eigene Referenz (nur beim Anlegen).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

rule_idintegerNur unter dieser Regel.
period_startdateErster Tag des Zeitraums (Y-m-d).
external_refstringIhre genaue Referenz.

/api/v1/objectives/{id}/record: achievements (array) — Eine Liste von {subject_id, measures: {Name des Messwerts: Zahl}}; Subjekte auf der Ebene der Regel, in den Standorten mit Zielwert.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/objectives

{
    "rule_id": 2,
    "name": "Vitamin C 1000",
    "period": "2026-09",
    "params": {
        "bonus": "2"
    },
    "targets": [
        {
            "work_unit_id": 12,
            "target": "30"
        }
    ],
    "external_ref": "CAMP-2026-09"
}

Beispielantwort

{
    "data": {
        "id": 31,
        "rule_id": 2,
        "rule": "Focus products",
        "name": "Vitamin C 1000",
        "description": null,
        "period": "2026-09",
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "params": {
            "bonus": "2"
        },
        "targets": [
            {
                "work_unit_id": 12,
                "target": "30"
            }
        ],
        "external_ref": "CAMP-2026-09",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Beurteilungen /reviews

Auf Beurteilungsbögen abgegebene Beurteilungen: wer, von wem, für welchen Zeitraum, Punkte und Ergebnis sowie die Antwort zu jedem Kriterium. Nur lesbar; Beurteilungen werden in der Anwendung abgegeben. Entwürfe sind laufende Arbeit der beurteilenden Person und werden nie aufgelistet.

Berechtigungen: reviews:read

Endpunkte

  • GET /api/v1/reviews Liste
  • GET /api/v1/reviews/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
form_idintegernur lesbar Die Version des Bogens.
formstringnur lesbar Der Name des Bogens.
employee_idintegernur lesbar Die beurteilte Person.
evaluator_idinteger | nullnur lesbar Das Konto der beurteilenden Person.
period_startdatenur lesbar Erster Tag des Zeitraums.
period_enddatenur lesbar Letzter Tag.
statussubmitted | cancellednur lesbar submitted oder cancelled.
total_pointsstring | nullnur lesbar Erreichte Punkte.
max_pointsstring | nullnur lesbar Mögliche Punkte.
resultstring | nullnur lesbar Das Ergebnis (Punkte oder ein Prozentsatz, wenn der Bogen einen liefert).
commenttext | nullnur lesbar Der Kommentar der beurteilenden Person, als reiner Text.
submitted_atdatetime | nullnur lesbar Wann sie abgegeben wurde.
cancelled_atdatetime | nullnur lesbar Wann sie storniert wurde.
answersarraynur lesbar Jedes Kriterium: key, die gewählten Optionen, ein Wert, seine Punkte und ein Kommentar.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statussubmitted | cancelledsubmitted oder cancelled.
employee_idintegerNur diese Person.
form_idintegerNur diese Version des Bogens.
period_startdateErster Tag des Zeitraums (Y-m-d).

Beispielantwort

{
    "data": {
        "id": 812,
        "form_id": 3,
        "form": "Monthly evaluation",
        "employee_id": 345,
        "evaluator_id": 12,
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "status": "submitted",
        "total_points": "8.00",
        "max_points": "10.00",
        "result": "80",
        "comment": null,
        "submitted_at": "2026-05-01T08:00:00Z",
        "cancelled_at": "2026-05-01T08:00:00Z",
        "answers": [
            {
                "criterion_key": "attitude",
                "selected": [
                    "teamwork"
                ],
                "value": null,
                "points": "2.00",
                "comment": null
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Wettbewerbe

Wettbewerbe /contests

Die gestarteten Wettbewerbe des Unternehmens (Entwürfe erscheinen nicht): was gemessen wird, wer antritt, über welche Zeiträume und wie man gewinnt. Nur lesend — Wettbewerbe werden in der App angelegt und geführt.

Berechtigungen: contests:read

Endpunkte

  • GET /api/v1/contests Liste
  • GET /api/v1/contests/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name (in der Sprache des Unternehmens).
descriptiontext | nullnur lesbar Beschreibung.
statusscheduled | running | closing | to_confirm | final | cancellednur lesbar scheduled, running, closing (Tage für verspätete Daten), to_confirm, final oder cancelled.
grainemployee | team | work_unit | department | geo_areanur lesbar Wer antritt: employee, team, work_unit, department oder geo_area.
period_typeweek | month | quarternur lesbar week, month oder quarter.
start_keystringnur lesbar Der erste Zeitraum (2026-11, 2026-W45, 2026-Q1).
period_countintegernur lesbar Wie viele aufeinanderfolgende Zeiträume.
starts_ondatenur lesbar Erster Tag.
ends_ondatenur lesbar Letzter Tag.
criterion_kindmetric | formula | scorecardnur lesbar Was gemessen wird: metric, formula oder scorecard.
modethreshold | ranknur lesbar threshold (alle, die das Ziel erreichen, gewinnen) oder rank (die ersten Plätze gewinnen).
measurevalue | improvement_pct | improvement_absnur lesbar value, improvement_pct oder improvement_abs.
visibilityleaders | own | hiddennur lesbar Was die Teilnehmenden währenddessen sehen: leaders, own oder hidden.
sponsor_idinteger | nullnur lesbar Der Hauptsponsor (siehe /merch-partners), falls vorhanden.
launched_atdatetimenur lesbar Gestartet.
confirmed_atdatetime | nullnur lesbar Wann die Ergebnisse bestätigt wurden.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusstringNur mit diesem Status.

Beispielantwort

{
    "data": {
        "id": 4,
        "name": "Store of the month",
        "description": null,
        "status": "running",
        "grain": "work_unit",
        "period_type": "month",
        "start_key": "2026-11",
        "period_count": 1,
        "starts_on": "2026-05-01",
        "ends_on": "2026-05-01",
        "criterion_kind": "metric",
        "mode": "rank",
        "measure": "value",
        "visibility": "leaders",
        "sponsor_id": 3,
        "launched_at": "2026-05-01T08:00:00Z",
        "confirmed_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Wettbewerbsergebnisse /contest-results

Bestätigte Ergebnisse, eines je Teilnahme — nach der Bestätigung unveränderlich. NULL heißt keine Daten, nie null. Das Ergebnis einer Person wird als über die API gelesen protokolliert.

Berechtigungen: contest_results:read

Endpunkte

  • GET /api/v1/contest-results Liste
  • GET /api/v1/contest-results/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
contest_idintegernur lesbar Der Wettbewerb.
subject_typeemployee | team | work_unit | department | geo_areanur lesbar employee, team, work_unit, department oder geo_area.
subject_idinteger | nullnur lesbar Die Teilnahme (leer nach der Anonymisierung).
valuenumber | nullnur lesbar Der Wert des Kriteriums im Wettbewerb.
baselinenumber | nullnur lesbar Der Durchschnitt der Zeiträume davor (Fortschrittswettbewerbe).
measurenumber | nullnur lesbar Was verglichen wurde: der Wert oder der Fortschritt.
placeinteger | nullnur lesbar Der Platz (Gleichstände teilen ihn).
tier_keystring | nullnur lesbar Die erreichte Stufe (Wettbewerbe mit Stufen).
winsbooleannur lesbar Ob gewonnen wurde.
eligiblebooleannur lesbar Ob teilnahmeberechtigt.
ineligible_reasonstring | nullnur lesbar Warum nicht: excluded, inactive, not_placed, not_present, not_employed_long_enough, no_data oder no_baseline.
period_keysarraynur lesbar Die Zeiträume des Wettbewerbs.
confirmed_atdatetimenur lesbar Bestätigt.

Filter

contest_idintegerNur dieses Wettbewerbs.
winsbooleantrue: nur Gewinner.

Beispielantwort

{
    "data": {
        "id": 120,
        "contest_id": 4,
        "subject_type": "work_unit",
        "subject_id": 12,
        "value": 1240.5,
        "baseline": 12.5,
        "measure": 1240.5,
        "place": 1,
        "tier_key": null,
        "wins": true,
        "eligible": true,
        "ineligible_reason": null,
        "period_keys": [
            "2026-11"
        ],
        "confirmed_at": "2026-05-01T08:00:00Z"
    }
}

Wettbewerbspreise /contest-awards

Gewonnene Preise, einer je Empfänger. Der Betrag eines Bonus nur mit dem Scope sensitive; nichts zu Steuern. Die Aktion deliver markiert einen Preis als übergeben, im Namen der Person, die den Schlüssel angelegt hat (sie muss in der App Preise übergeben dürfen).

Berechtigungen: contest_awards:read, contest_awards:write

Endpunkte

  • GET /api/v1/contest-awards Liste
  • GET /api/v1/contest-awards/{id} Ein Eintrag
  • POST /api/v1/contest-awards/{id}/deliver Den Preis als übergeben markieren.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
contest_idintegernur lesbar Der Wettbewerb.
reward_idintegernur lesbar Der Preis (siehe /contest-rewards).
employee_idinteger | nullnur lesbar Wer ihn erhält (leer nach der Anonymisierung).
subject_typestringnur lesbar Was gewonnen hat: die Person oder ihr Team, Standort, ihre Abteilung oder ihr Bereich.
subject_idinteger | nullnur lesbar Die gewinnende Teilnahme.
quantityintegernur lesbar Anzahl.
valuenumber | nullnur lesbar Informativer Wert beim Gewinn.
amountnumber | nullnur lesbar Berechtigung sensitiveDer Betrag eines Bonus (nur mit dem Scope sensitive).
currencystring | nullnur lesbar Die Währung von Wert oder Betrag.
daysnumber | nullnur lesbar Die Tage eines freien Tages.
statuspending | ready | delivered | acknowledged | declined | revokednur lesbar pending, ready, delivered, acknowledged, declined oder revoked.
sponsor_may_knowbooleannur lesbar Ob der Gewinner zugestimmt hat, dass der Sponsor es erfährt.
delivered_atdatetime | nullnur lesbar Übergeben.
acknowledged_atdatetime | nullnur lesbar Erhalten, vom Gewinner bestätigt.
created_atdatetimenur lesbar Angelegt.

Filter

contest_idintegerNur dieses Wettbewerbs.
employee_idintegerNur dieser Person.
statusstringNur mit diesem Status.

Beispielantwort

{
    "data": {
        "id": 55,
        "contest_id": 4,
        "reward_id": 7,
        "employee_id": 31,
        "subject_type": "employee",
        "subject_id": 31,
        "quantity": 1,
        "value": 150,
        "amount": 250,
        "currency": "RON",
        "days": 12.5,
        "status": "pending",
        "sponsor_may_know": false,
        "delivered_at": "2026-05-01T08:00:00Z",
        "acknowledged_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z"
    }
}

Preiskatalog /contest-rewards

Was Wettbewerbe vergeben können: Produkte, Gutscheine, Boni, freie Tage, Erlebnisse oder nur Anerkennung. Jede Art behält nur, was sie braucht (der Wert eines Bonus ist sein Betrag; Anerkennung hat weder Wert noch Bestand). Geschrieben im Namen der Person, die den Schlüssel angelegt hat; sie muss in der App Preise verwalten dürfen.

Berechtigungen: contest_rewards:read, contest_rewards:write

Endpunkte

  • GET /api/v1/contest-rewards Liste
  • GET /api/v1/contest-rewards/{id} Ein Eintrag
  • POST /api/v1/contest-rewards Anlegen
  • PATCH /api/v1/contest-rewards/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
kindproduct | voucher | bonus | day_off | experience | recognitionerforderlich product, voucher, bonus, day_off, experience oder recognition.
namestringerforderlich Bezeichnung.
descriptiontext | null Beschreibung.
sponsor_idinteger | null Der Sponsor, der ihn stellt (siehe /merch-partners); leer: das Unternehmen.
valuenumber | null Informativer Wert.
currencystring | null Währung von Wert oder Betrag.
amountnumber | null Berechtigung sensitiveDer Betrag eines Bonus (nur mit dem Scope sensitive).
leave_type_idinteger | null Ein freier Tag: die Abwesenheitsart, deren Saldo die Tage erhält.
daysnumber | null Ein freier Tag: ganze oder halbe Tage.
stockinteger | null Wie viele es gibt; leer: unbegrenzt.
availableinteger | nullnur lesbar Wie viele noch vergeben werden können (nur lesend).
is_activeboolean Ob neue Wettbewerbe ihn anbieten dürfen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

kindstringNur dieser Art.
is_activebooleantrue: nur aktive.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/contest-rewards

{
    "kind": "voucher",
    "name": "Book voucher",
    "sponsor_id": 3,
    "value": 150,
    "currency": "RON",
    "amount": 250,
    "stock": 10,
    "is_active": true
}

Beispielantwort

{
    "data": {
        "id": 7,
        "kind": "voucher",
        "name": "Book voucher",
        "description": null,
        "sponsor_id": 3,
        "value": 150,
        "currency": "RON",
        "amount": 250,
        "leave_type_id": 1,
        "days": 12.5,
        "stock": 10,
        "available": 8,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Weiterbildung, Audits und Arbeitsschutz

Kurse /courses

Der Kurskatalog. Titel und Beschreibung werden in der Sprache des Unternehmens geschrieben (andere Sprachen werden in der Anwendung übersetzt); Kapitel und Titelbilder werden in der Anwendung angelegt. Ein Kurs kann nur gelöscht werden, solange er nie jemandem zugewiesen wurde – sonst archivieren Sie ihn.

Berechtigungen: courses:read, courses:write

Endpunkte

  • GET /api/v1/courses Liste
  • GET /api/v1/courses/{id} Ein Eintrag
  • POST /api/v1/courses Anlegen
  • PATCH /api/v1/courses/{id} Ändern
  • DELETE /api/v1/courses/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
titlestringerforderlich Titel.
descriptiontext | null Kurzbeschreibung, reiner Text.
category_idinteger | null Kategorie.
categorystring | nullnur lesbar Name der Kategorie.
authorstring | null Verfasst von.
statusdraft | published | archivederforderlich draft, published oder archived; nur veröffentlichte Kurse können zugewiesen werden.
estimated_minutesinteger | null Geschätzte Dauer in Minuten.
validity_monthsinteger | null Wie viele Monate das Zertifikat gültig bleibt; leer: läuft nicht ab.
issues_certificateboolean Ob der Abschluss ein Zertifikat ausstellt.
recertifiesboolean Ob Personen vor Ablauf des Zertifikats erneut eingeschrieben werden.
pointsintegererforderlich Beim Abschluss erhaltene Punkte.
chapters_countintegernur lesbar Anzahl der Kapitel.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusdraft | published | archivedNur mit diesem Status.
category_idintegerNur in dieser Kategorie.
qstringTeil des Titels.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/courses

{
    "title": "Siguranța la incendiu",
    "status": "published",
    "estimated_minutes": 20,
    "validity_months": 12,
    "issues_certificate": true,
    "recertifies": false,
    "points": 10
}

Beispielantwort

{
    "data": {
        "id": 7,
        "title": "Siguranța la incendiu",
        "description": null,
        "category_id": 1,
        "category": "Obligatorii",
        "author": null,
        "status": "published",
        "estimated_minutes": 20,
        "validity_months": 12,
        "issues_certificate": true,
        "recertifies": false,
        "points": 10,
        "chapters_count": 4,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zuweisungen von Weiterbildung /learning-assignments

Ein veröffentlichter Kurs (oder ein eigenständiger Test), der Personen gegeben wird: allen, einem Standort, einem Gebiet, einer Abteilung, einer Position oder namentlich genannten Mitarbeitern. Die Personen werden sofort eingeschrieben. Löschen nur, solange niemand begonnen hat.

Berechtigungen: learning_assignments:read, learning_assignments:write

Endpunkte

  • GET /api/v1/learning-assignments Liste
  • GET /api/v1/learning-assignments/{id} Ein Eintrag
  • POST /api/v1/learning-assignments Anlegen
  • DELETE /api/v1/learning-assignments/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
course_idinteger | null Der Kurs (oder test_id).
test_idinteger | null Ein eigenständiger Test (oder course_id).
available_fromdateerforderlich Ab wann er absolviert werden kann.
due_ondate | null Fälligkeit.
enrolls_newcomersboolean Ob Personen, die später zu den Zielen passen, automatisch eingeschrieben werden.
targetsarrayerforderlich Wer: eine Liste von {type, id}; type ist all, employee, position, work_unit, department oder geo_area (id leer bei all).
enrollments_countintegernur lesbar Eingeschriebene Personen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

course_idintegerNur für diesen Kurs.
test_idintegerNur für diesen Test.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/learning-assignments

{
    "course_id": 7,
    "available_from": "2026-05-01",
    "due_on": "2026-05-31",
    "enrolls_newcomers": true,
    "targets": [
        {
            "type": "work_unit",
            "id": 12
        }
    ]
}

Beispielantwort

{
    "data": {
        "id": 31,
        "course_id": 7,
        "test_id": 1,
        "available_from": "2026-05-01",
        "due_on": "2026-05-31",
        "enrolls_newcomers": true,
        "targets": [
            {
                "type": "work_unit",
                "id": 12
            }
        ],
        "enrollments_count": 14,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Einschreibungen /enrollments

Wer in welchem Kurs oder Test eingeschrieben ist und wie weit die Person gekommen ist. Aktionen: eine spätere Fälligkeit, ein weiterer Versuch, die Befreiung einer Person, die noch nicht begonnen hat.

Berechtigungen: enrollments:read, enrollments:write

Endpunkte

  • GET /api/v1/enrollments Liste
  • GET /api/v1/enrollments/{id} Ein Eintrag
  • POST /api/v1/enrollments/{id}/extend Eine spätere Fälligkeit festlegen.
  • POST /api/v1/enrollments/{id}/grant-attempt Einen weiteren Testversuch erlauben (nicht nach dem Bestehen).
  • POST /api/v1/enrollments/{id}/excuse Die Person befreien (nur bevor sie begonnen hat).

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
assignment_idinteger | nullnur lesbar Die Zuweisung, aus der sie stammt.
employee_idintegernur lesbar Die Person.
course_idinteger | nullnur lesbar Der Kurs.
test_idinteger | nullnur lesbar Der Test.
available_fromdate | nullnur lesbar Verfügbar ab.
due_ondate | nullnur lesbar Fälligkeit.
statusassigned | in_progress | awaiting_grading | completed | failed | excusednur lesbar assigned, in_progress, awaiting_grading, completed, failed oder excused.
started_atdatetime | nullnur lesbar Begonnen.
completed_atdatetime | nullnur lesbar Abgeschlossen.
scorenumber | nullnur lesbar Testergebnis (%).
passedboolean | nullnur lesbar Ob der Test bestanden wurde.
extra_attemptsintegernur lesbar Gewährte zusätzliche Versuche.
is_overduebooleannur lesbar Überfällig und nicht abgeschlossen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

employee_idintegerNur diese Person.
course_idintegerNur dieser Kurs.
test_idintegerNur dieser Test.
assignment_idintegerNur diese Zuweisung.
statusassigned | in_progress | awaiting_grading | completed | failed | excusedNur mit diesem Status.
completed_sincedateAbgeschlossen ab diesem Datum (Y-m-d).

/api/v1/enrollments/{id}/extend: due_on (date) — Die neue Fälligkeit, nicht vor Öffnung der Einschreibung.

Beispielantwort

{
    "data": {
        "id": 501,
        "assignment_id": 31,
        "employee_id": 345,
        "course_id": 7,
        "test_id": 1,
        "available_from": "2026-05-01",
        "due_on": "2026-05-31",
        "status": "completed",
        "started_at": "2026-05-01T08:00:00Z",
        "completed_at": "2026-05-01T08:00:00Z",
        "score": 90,
        "passed": true,
        "extra_attempts": 0,
        "is_overdue": false,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zertifikate /certificates

Beim Abschluss eines Kurses erworbene Zertifikate, mit dem Code, den jeder auf der Zertifikatsseite prüfen kann.

Berechtigungen: certificates:read

Endpunkte

  • GET /api/v1/certificates Liste
  • GET /api/v1/certificates/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
enrollment_idintegernur lesbar Die Einschreibung, aus der es stammt.
employee_idintegernur lesbar Die Person.
course_idintegernur lesbar Der Kurs.
numberstringnur lesbar Zertifikatsnummer.
verification_codestringnur lesbar Der öffentliche Prüfcode.
issued_ondatenur lesbar Ausgestellt am.
expires_ondate | nullnur lesbar Gültig bis; leer: läuft nicht ab.
is_validbooleannur lesbar Heute gültig.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

employee_idintegerNur diese Person.
course_idintegerNur dieser Kurs.
issued_sincedateAusgestellt ab diesem Datum (Y-m-d).

Beispielantwort

{
    "data": {
        "id": 88,
        "enrollment_id": 501,
        "employee_id": 345,
        "course_id": 7,
        "number": "FV-2026-0042",
        "verification_code": "K7Q2M9XA",
        "issued_on": "2026-05-12",
        "expires_on": "2027-05-12",
        "is_valid": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Audits /audits

Audits der Standorte mit ihren Feststellungen, Punkt für Punkt. Nur lesbar: Ein Audit wird in der Anwendung durchgeführt.

Berechtigungen: audits:read

Endpunkte

  • GET /api/v1/audits Liste
  • GET /api/v1/audits/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
work_unit_idintegernur lesbar Der geprüfte Standort.
template_namestringnur lesbar Die verwendete Checkliste.
auditor_idinteger | nullnur lesbar Wer es durchgeführt hat (Konto).
statusdraft | completednur lesbar draft oder completed.
conducted_atdatetime | nullnur lesbar Wann es stattfand.
completed_atdatetime | nullnur lesbar Wann es abgeschlossen wurde.
scorenumber | nullnur lesbar Score (%).
pass_scorenumber | nullnur lesbar Bestehensgrenze (%).
passedboolean | nullnur lesbar Bestanden (nur abgeschlossene Audits).
critical_findingsintegernur lesbar Nicht erfüllte kritische Punkte.
is_self_checkbooleannur lesbar Von einer Person durchgeführt, die am Standort arbeitet oder ihn leitet (zählt nicht in die Audit-Kennzahlen).
notetext | nullnur lesbar Anmerkungen.
findingsarraynur lesbar Jeder Punkt: {id, section, item, weight, critical, result (ok, not_ok, na), comment}.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

work_unit_idintegerNur dieser Standort.
statusdraft | completedNur mit diesem Status.
conducted_fromdateAm oder nach diesem Datum durchgeführt.
conducted_todateAm oder vor diesem Datum durchgeführt.

Beispielantwort

{
    "data": {
        "id": 19,
        "work_unit_id": 12,
        "template_name": "Verificare lunară farmacie",
        "auditor_id": 1,
        "status": "completed",
        "conducted_at": "2026-05-01T08:00:00Z",
        "completed_at": "2026-05-01T08:00:00Z",
        "score": 88.89,
        "pass_score": 80,
        "passed": true,
        "critical_findings": 0,
        "is_self_check": true,
        "note": null,
        "findings": [
            {
                "section": "Frigider",
                "item": "Termometrul este calibrat",
                "weight": 2,
                "critical": true,
                "result": "not_ok",
                "comment": "Ultima calibrare în martie."
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Maßnahmenpläne aus Audits /audit-action-plans

Nach Audits festgelegte Korrekturmaßnahmen. Sie werden wie auf der Audit-Seite weitergeführt: mit einer Notiz als erledigt markiert, bestätigt, mit einem Grund wieder geöffnet oder storniert.

Berechtigungen: audit_action_plans:read, audit_action_plans:write

Endpunkte

  • GET /api/v1/audit-action-plans Liste
  • GET /api/v1/audit-action-plans/{id} Ein Eintrag
  • POST /api/v1/audit-action-plans/{id}/mark-done Eine offene Maßnahme als erledigt markieren.
  • POST /api/v1/audit-action-plans/{id}/verify Eine erledigte Maßnahme annehmen.
  • POST /api/v1/audit-action-plans/{id}/reopen Eine erledigte Maßnahme mit Grund zurückschicken.
  • POST /api/v1/audit-action-plans/{id}/cancel Eine offene oder erledigte Maßnahme stornieren.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
audit_idintegernur lesbar Das Audit.
result_idinteger | nullnur lesbar Die Feststellung, auf die sie antwortet.
descriptiontextnur lesbar Was getan werden muss.
responsible_idinteger | nullnur lesbar Wer es tun muss (Konto).
due_ondatenur lesbar Fälligkeit.
statusopen | done | verified | cancellednur lesbar open, done, verified oder cancelled.
is_overduebooleannur lesbar Offen und überfällig.
done_notetext | nullnur lesbar Was getan wurde (und warum sie wieder geöffnet wurde).
done_atdatetime | nullnur lesbar Als erledigt markiert.
verified_byinteger | nullnur lesbar Wer sie bestätigt hat (Konto).
verified_atdatetime | nullnur lesbar Bestätigt.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

audit_idintegerNur für dieses Audit.
statusopen | done | verified | cancelledNur mit diesem Status.
responsible_idintegerNur für diese Person.

/api/v1/audit-action-plans/{id}/mark-done: note (text) — Was getan wurde.

/api/v1/audit-action-plans/{id}/reopen: reason (text) — Warum sie nicht angenommen wird.

Beispielantwort

{
    "data": {
        "id": 4,
        "audit_id": 19,
        "result_id": 1,
        "description": "Calibrați termometrul frigiderului și păstrați certificatul.",
        "responsible_id": 1,
        "due_on": "2026-05-20",
        "status": "open",
        "is_overdue": true,
        "done_note": null,
        "done_at": "2026-05-01T08:00:00Z",
        "verified_by": 1,
        "verified_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Arbeitsschutzarten /ssm-types

Die Arten von Arbeitsschutzunterweisungen und -vorsorge, die das Unternehmen erfasst, mit ihrer Gültigkeitsdauer.

Berechtigungen: ssm_types:read

Endpunkte

  • GET /api/v1/ssm-types Liste
  • GET /api/v1/ssm-types/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name.
validity_monthsinteger | nullnur lesbar Monate der Gültigkeit; leer: läuft nicht ab.
is_requiredbooleannur lesbar Für alle erforderlich.
is_activebooleannur lesbar In Verwendung.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 2,
        "name": "Instruire periodică",
        "validity_months": 6,
        "is_required": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Arbeitsschutz-Nachweise /ssm-records

Wer welche Arbeitsschutzunterweisung oder -vorsorge wann hatte und bis wann sie gilt (aus der Art berechnet). Ein Nachweis pro Aufruf.

Berechtigungen: ssm_records:read, ssm_records:write

Endpunkte

  • GET /api/v1/ssm-records Liste
  • GET /api/v1/ssm-records/{id} Ein Eintrag
  • POST /api/v1/ssm-records Anlegen
  • DELETE /api/v1/ssm-records/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
employee_idintegererforderlich Die Person.
type_idintegererforderlich Die Unterweisung oder Vorsorge.
done_ondateerforderlich Wann sie stattfand (nicht in der Zukunft).
valid_untildate | nullnur lesbar Gültig bis (aus der Art).
statevalid | expiring | expired | missing | nonenur lesbar Heute: valid, expiring, expired.
trainerstring | null Unterweisende Person oder Arzt / Ärztin.
notestring | null Anmerkungen.
recorded_byinteger | nullnur lesbar Wer ihn erfasst hat (Konto).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

employee_idintegerNur diese Person.
type_idintegerNur diese Art.
valid_until_beforedateGültig bis zu diesem Datum oder früher.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/ssm-records

{
    "employee_id": 345,
    "type_id": 2,
    "done_on": "2026-04-15"
}

Beispielantwort

{
    "data": {
        "id": 120,
        "employee_id": 345,
        "type_id": 2,
        "done_on": "2026-04-15",
        "valid_until": "2026-10-15",
        "state": "valid",
        "trainer": null,
        "note": null,
        "recorded_by": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Dokumente, Anfragen, Umfragen und Kommunikation

Dokumentkategorien /document-categories

Die Kategorien, unter denen Dokumente abgelegt werden, für das ganze Unternehmen oder für Standorte.

Berechtigungen: document_categories:read

Endpunkte

  • GET /api/v1/document-categories Liste
  • GET /api/v1/document-categories/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name, in der angefragten Sprache.
scopecompany | unitnur lesbar company (Unternehmensdokumente) oder unit (Standortdokumente).
sortintegernur lesbar Position in Listen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

scopecompany | unitNur Unternehmens- oder nur Standortkategorien.

Beispielantwort

{
    "data": {
        "id": 4,
        "name": "Autorizații",
        "scope": "company",
        "sort": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Dokumente /documents

Genehmigungen, Verträge und Regelungen mit ihrem Ablaufdatum. Die API liest die Angaben eines Dokuments sowie Name, Größe und Typ der aktuellen Datei; die Datei selbst wird in der Anwendung heruntergeladen. Eine Datei wird als {"name", "content_base64"} gesendet (dieselben Typen wie in der Anwendung – PDF, Office, Bilder, ZIP – höchstens 50 MB); eine an ein bestehendes Dokument gesendete Datei fügt eine neue Version hinzu. Löschen verschiebt das Dokument in den Papierkorb, aus dem es in der Anwendung wiederhergestellt werden kann.

Berechtigungen: documents:read, documents:write

Endpunkte

  • GET /api/v1/documents Liste
  • GET /api/v1/documents/{id} Ein Eintrag
  • POST /api/v1/documents Anlegen
  • PATCH /api/v1/documents/{id} Ändern
  • DELETE /api/v1/documents/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
titlestringerforderlich Titel.
descriptiontext | null Beschreibung.
category_idinteger | null Kategorie (siehe /document-categories).
work_unit_idinteger | null Der Standort, zu dem es gehört; leer für ein Unternehmensdokument. Nur beim Anlegen festgelegt.
is_internalboolean Nur sichtbar für die Verwaltung der Dokumente.
expires_ondate | null Ablaufdatum.
expiry_statevalid | expiring | expired | nullnur lesbar valid, expiring oder expired (leer ohne Ablaufdatum).
repeat_monthsinteger | null Alle so viele Monate erneuert.
alert_daysarray | null Tage vor Ablauf, an denen Erinnerungen versendet werden (höchstens 6).
versionsintegernur lesbar Wie viele Versionen der Datei es gibt.
file_namestring | nullnur lesbar Der Name der aktuellen Datei.
file_sizeinteger | nullnur lesbar Ihre Größe in Byte.
file_mimestring | nullnur lesbar Ihr Typ.
filefileerforderlich Die Datei: {"name": "…", "content_base64": "…"}. Beim Anlegen erforderlich; beim Ändern fügt sie eine Version hinzu.
version_notestring | null Ein Hinweis zur Version der Datei (angezeigt: der der aktuellen Version).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

work_unit_idintegerNur die Dokumente dieses Standorts.
category_idintegerNur diese Kategorie.
companybooleantrue: nur Unternehmensdokumente; false: nur Standortdokumente.
expires_beforedateLäuft an oder vor diesem Datum ab.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/documents

{
    "title": "Autorizație sanitară de funcționare",
    "category_id": 4,
    "work_unit_id": 12,
    "is_internal": false,
    "expires_on": "2026-12-31",
    "repeat_months": 12,
    "alert_days": [
        30,
        7
    ],
    "file": {
        "name": "document.pdf",
        "content_base64": "JVBERi0xLjQK…"
    }
}

Beispielantwort

{
    "data": {
        "id": 31,
        "title": "Autorizație sanitară de funcționare",
        "description": null,
        "category_id": 4,
        "work_unit_id": 12,
        "is_internal": false,
        "expires_on": "2026-12-31",
        "expiry_state": "valid",
        "repeat_months": 12,
        "alert_days": [
            30,
            7
        ],
        "versions": 2,
        "file_name": "autorizatie.pdf",
        "file_size": 184220,
        "file_mime": "application/pdf",
        "version_note": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Servicekategorien /service-categories

Worum es bei Serviceanfragen geht (Instandhaltung, IT …) und ob sie zuerst genehmigt werden müssen.

Berechtigungen: service_categories:read

Endpunkte

  • GET /api/v1/service-categories Liste
  • GET /api/v1/service-categories/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name, in der angefragten Sprache.
is_activebooleannur lesbar Ob darunter Anfragen gestellt werden können.
needs_approvalbooleannur lesbar Ob eine Anfrage vor der Öffnung auf Genehmigung wartet.
sortintegernur lesbar Position in Listen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 2,
        "name": "Mentenanță și reparații",
        "is_active": true,
        "needs_approval": false,
        "sort": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Serviceanfragen /service-requests

Anfragen, an einem Standort etwas zu reparieren oder bereitzustellen, mit ihrem Verlauf. Gestellt für die in requested_by angegebene Person (die für diesen Standort Anfragen stellen können muss) oder für die Person, die den Schlüssel angelegt hat; der Genehmigungsablauf der Kategorie gilt. Weitergeführt mit der Aktion move, wie es diese Person auf dem Bildschirm darf.

Berechtigungen: service_requests:read, service_requests:write

Endpunkte

  • GET /api/v1/service-requests Liste
  • GET /api/v1/service-requests/{id} Ein Eintrag
  • POST /api/v1/service-requests Anlegen
  • POST /api/v1/service-requests/{id}/move Die Anfrage in einen anderen Status bringen (in_progress, resolved, unresolved, open, cancelled), wie es die Person darf, die den Schlüssel angelegt hat. unresolved und Wiederöffnen brauchen einen Kommentar.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
category_idintegererforderlich Kategorie (siehe /service-categories).
work_unit_idintegererforderlich Der Standort, für den sie ist.
titlestringerforderlich Kurzer Titel.
descriptiontexterforderlich Was nicht stimmt oder gebraucht wird.
requested_byinteger Das Konto, für das sie gestellt wird (eine Person des Unternehmens); weggelassen: die Person, die den Schlüssel angelegt hat.
employee_idintegernur lesbar Der Personaldatensatz der anfragenden Person.
statusawaiting_approval | open | in_progress | resolved | unresolved | rejected | cancellednur lesbar awaiting_approval, open, in_progress, resolved, unresolved, rejected oder cancelled.
assigned_tointeger | nullnur lesbar Das Konto, das sie übernommen hat.
closed_atdatetime | nullnur lesbar Wann sie geschlossen wurde.
historyarraynur lesbar Jede Statusänderung: von, nach, Kommentar, von wem, wann.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusawaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelledNur mit diesem Status.
category_idintegerNur diese Kategorie.
work_unit_idintegerNur dieser Standort.
closed_sincedateAbgeschlossen ab diesem Datum (Y-m-d).

/api/v1/service-requests/{id}/move: status (awaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelled) — Der neue Status.; comment (text) — Warum (erforderlich bei unresolved und beim Wiederöffnen).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/service-requests

{
    "category_id": 2,
    "work_unit_id": 12,
    "title": "Frigiderul de vaccinuri nu mai răcește",
    "description": "text",
    "requested_by": 17
}

Beispielantwort

{
    "data": {
        "id": 88,
        "category_id": 2,
        "work_unit_id": 12,
        "title": "Frigiderul de vaccinuri nu mai răcește",
        "description": "text",
        "requested_by": 17,
        "employee_id": 345,
        "status": "open",
        "assigned_to": 1,
        "closed_at": "2026-05-01T08:00:00Z",
        "history": [
            {
                "status_from": "open",
                "status_to": "in_progress",
                "comment": "Vine tehnicianul mâine.",
                "user_id": 9,
                "at": "2026-05-04T08:00:00Z"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Material /materials

Was Standorte anfordern können, mit dem aktuellen Bestand, wenn er geführt wird.

Berechtigungen: materials:read

Endpunkte

  • GET /api/v1/materials Liste
  • GET /api/v1/materials/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name.
descriptiontext | nullnur lesbar Beschreibung.
unitstringnur lesbar Einheit.
track_stockbooleannur lesbar Ob der Bestand geführt wird.
stocknumber | nullnur lesbar Aktueller Bestand (leer, wenn nicht geführt).
is_activebooleannur lesbar Ob es angefordert werden kann.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 7,
        "name": "Mănuși nitril",
        "description": null,
        "unit": "cutie",
        "track_stock": true,
        "stock": 35,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Materialanfragen /material-requests

Anfragen für Material, mit ihren Positionen. Gestellt für die Person in requested_by (oder die Person, die den Schlüssel angelegt hat), für ein aktives Material und einen Standort, für den sie anfragen darf; dann übernommen, abgeschlossen (was den Bestand verringert) oder storniert, wie es diese Person auf dem Bildschirm darf.

Berechtigungen: material_requests:read, material_requests:write

Endpunkte

  • GET /api/v1/material-requests Liste
  • GET /api/v1/material-requests/{id} Ein Eintrag
  • POST /api/v1/material-requests Anlegen
  • POST /api/v1/material-requests/{id}/take Eine neue Anfrage zur Bearbeitung übernehmen.
  • POST /api/v1/material-requests/{id}/complete Abschließen: Der Bestand geführter Materialien sinkt.
  • POST /api/v1/material-requests/{id}/cancel Eine noch nicht abgeschlossene Anfrage stornieren.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
work_unit_idintegererforderlich Der Standort, für den sie ist.
requested_byinteger Das Konto, für das sie gestellt wird; weggelassen: die Person, die den Schlüssel angelegt hat.
statusnew | taken | completed | cancellednur lesbar new, taken, completed oder cancelled.
handled_byinteger | nullnur lesbar Das bearbeitende Konto.
notetext | null Eine Anmerkung.
itemsarrayerforderlich Was angefordert wird: [{"material_id": 7, "quantity": 5}] (mindestens eine Position).
completed_atdatetime | nullnur lesbar Wann sie abgeschlossen wurde.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusnew | taken | completed | cancelledNur mit diesem Status.
work_unit_idintegerNur dieser Standort.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/material-requests

{
    "work_unit_id": 12,
    "requested_by": 17,
    "items": [
        {
            "material_id": 7,
            "quantity": 5
        }
    ]
}

Beispielantwort

{
    "data": {
        "id": 51,
        "work_unit_id": 12,
        "requested_by": 17,
        "status": "new",
        "handled_by": 1,
        "note": null,
        "items": [
            {
                "material_id": 7,
                "quantity": 5
            }
        ],
        "completed_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Umfragen /surveys

Veröffentlichte und geschlossene Umfragen mit ihren Fragen und ihren Ergebnissen nur als Summen: wie viele jede Antwort gewählt haben, der Durchschnitt einer Skala und wie viele eine Freitextfrage beantwortet haben – nie, was sie geschrieben haben. Die Ergebnisse einer anonymen Umfrage bleiben verborgen, solange ihre Antworten versiegelt sind und solange sie weniger als 5 Antworten hat.

Berechtigungen: surveys:read

Endpunkte

  • GET /api/v1/surveys Liste
  • GET /api/v1/surveys/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
titlestringnur lesbar Titel.
descriptiontext | nullnur lesbar Beschreibung.
is_anonymousbooleannur lesbar Ob die Antworten anonym sind.
is_mandatorybooleannur lesbar Ob die Teilnahme verpflichtend ist.
statuspublished | closednur lesbar published oder closed.
opens_atdatetime | nullnur lesbar Wann sie beginnt.
closes_atdatetime | nullnur lesbar Wann sie endet.
published_atdatetime | nullnur lesbar Wann sie veröffentlicht wurde.
series_idinteger | nullnur lesbar Die Umfrageserie, deren Ausgabe sie ist; leer bei einer einmaligen Umfrage.
editioninteger | nullnur lesbar Ihre Nummer in der Serie.
questionsarraynur lesbar Die Fragen: id, type (single, multiple, scale, text), text, required, options.
resultsobjectnur lesbar Summen: hidden, sealed, responses, assigned, completed und pro Frage, wie viele geantwortet haben, Anzahl pro Option oder Skalenwert, der Durchschnitt.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statuspublished | closedpublished oder closed.
is_anonymousbooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 5,
        "title": "Climatul de lucru",
        "description": null,
        "is_anonymous": true,
        "is_mandatory": false,
        "status": "closed",
        "opens_at": "2026-05-01T08:00:00Z",
        "closes_at": "2026-05-01T08:00:00Z",
        "published_at": "2026-05-01T08:00:00Z",
        "series_id": 1,
        "edition": 1,
        "questions": [
            {
                "id": 11,
                "type": "single",
                "text": "Ați recomanda compania?",
                "is_required": true,
                "options": [
                    {
                        "id": 31,
                        "label": "Da"
                    }
                ]
            }
        ],
        "results": {
            "hidden": false,
            "responses": 14,
            "questions": [
                {
                    "question_id": 11,
                    "answered": 14,
                    "counts": {
                        "31": 11
                    },
                    "average": null
                }
            ]
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Antworten auf Umfragen /survey-responses

Antworten auf namentliche Umfragen, eine Teilnahme pro Person mit ihren Antworten. Die Antworten einer anonymen Umfrage werden nie einzeln ausgegeben – nur ihre Summen, unter /surveys.

Berechtigungen: survey_responses:read

Endpunkte

  • GET /api/v1/survey-responses Liste
  • GET /api/v1/survey-responses/{id} Ein Eintrag

Felder

NameTypBeschreibung
idstringnur lesbar Kennung (eine UUID).
survey_idintegernur lesbar Die Umfrage.
employee_idintegernur lesbar Wer geantwortet hat.
submitted_atdatetime | nullnur lesbar Wann.
answersarraynur lesbar Die Antworten: Frage, gewählte Option, Wert (Skala) oder Text.

Filter

survey_idintegerNur die Antworten dieser Umfrage.
employee_idintegerNur die Antworten dieser Person.

Beispielantwort

{
    "data": {
        "id": "9b2f4c1e-6f0a-4e7c-9a51-3c2d1e0f7a88",
        "survey_id": 5,
        "employee_id": 345,
        "submitted_at": "2026-05-01T08:00:00Z",
        "answers": [
            {
                "question_id": 11,
                "option_id": 31,
                "value": null,
                "text": null
            }
        ]
    }
}

Beiträge /posts

Social-Beiträge für das ganze Unternehmen (nicht in einer Gruppe), veröffentlicht. Angelegt von der Person, die den Schlüssel angelegt hat: ein Beitrag, oder eine Neuigkeit, eine Ankündigung, eine Aktion oder ein Wettbewerb, wenn sie Ankündigungen veröffentlichen darf; der Text ist reiner Text, mit einer Leerzeile zwischen Absätzen.

Berechtigungen: posts:read, posts:write

Endpunkte

  • GET /api/v1/posts Liste
  • GET /api/v1/posts/{id} Ein Eintrag
  • POST /api/v1/posts Anlegen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
typepost | news | announcement | promotion | contesterforderlich post, news, announcement, promotion oder contest.
titlestring | null Titel (optional).
bodytexterforderlich Der Text (beim Lesen reiner Text).
authorstring | nullnur lesbar Wer ihn geschrieben hat.
comments_enabledboolean Ob kommentiert werden kann.
comments_countintegernur lesbar Wie viele Kommentare.
published_atdatetime | null Wann er veröffentlicht wird; ein Zeitpunkt in der Zukunft plant ihn ein.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

typepost | news | announcement | promotion | contestNur diese Art.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/posts

{
    "type": "announcement",
    "title": "Program de sărbători",
    "body": "Între 24 și 26 decembrie programul este 9–14.",
    "comments_enabled": true
}

Beispielantwort

{
    "data": {
        "id": 120,
        "type": "announcement",
        "title": "Program de sărbători",
        "body": "Între 24 și 26 decembrie programul este 9–14.",
        "author": "Maria Matei",
        "comments_enabled": true,
        "comments_count": 3,
        "published_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Artikel der Wissensdatenbank /knowledge-articles

Die veröffentlichten Artikel der Wissensdatenbank (Abläufe, Anleitungen), mit dem Text als reinem Text, in der angefragten Sprache (Accept-Language) oder der des Unternehmens.

Berechtigungen: knowledge_articles:read

Endpunkte

  • GET /api/v1/knowledge-articles Liste
  • GET /api/v1/knowledge-articles/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
category_idinteger | nullnur lesbar Thema.
categorystring | nullnur lesbar Name des Themas.
titlestringnur lesbar Titel.
summarytext | nullnur lesbar Zusammenfassung.
bodytext | nullnur lesbar Der Artikel, als reiner Text.
is_featuredbooleannur lesbar Ob er empfohlen ist.
published_atdatetime | nullnur lesbar Erstmals veröffentlicht.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

category_idintegerNur dieses Thema.
is_featuredbooleantrue oder false.

Beispielantwort

{
    "data": {
        "id": 9,
        "category_id": 2,
        "category": "Operațiuni",
        "title": "Recepția mărfii",
        "summary": null,
        "body": null,
        "is_featured": true,
        "published_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kunden (CRM)

Kunden /crm-contacts

Die Personen, die das Unternehmen betreut – Kunden und Interessenten. Eine E-Mail ist im Unternehmen eindeutig (eine zweite wird abgelehnt). Die Marketing-Einwilligung wird nie mit dem Eintrag geschrieben: Sie ändert sich nur über die Aktion consent, die ihren Verlauf festhält (erteilt oder widerrufen, wie, wann, von wem). Die Aktion erase löscht die Daten einer Person auf ihren Wunsch und kann nicht rückgängig gemacht werden: Name, E-Mail, Telefon, Notizen und was über sie geschrieben wurde, verschwinden, die Zahlen (Käufe, Werte von Verkaufschancen, Bewertungen) bleiben, und der Eintrag kann nicht mehr geändert werden.

Berechtigungen: crm_contacts:read, crm_contacts:write

Endpunkte

  • GET /api/v1/crm-contacts Liste
  • GET /api/v1/crm-contacts/{id} Ein Eintrag
  • POST /api/v1/crm-contacts Anlegen
  • PATCH /api/v1/crm-contacts/{id} Ändern
  • DELETE /api/v1/crm-contacts/{id} Löschen
  • POST /api/v1/crm-contacts/{id}/consent Erfassen, dass die Person ihre Marketing-Einwilligung erteilt oder widerrufen hat, und wie.
  • POST /api/v1/crm-contacts/{id}/erase Die Daten der Person auf ihren Wunsch löschen (DSGVO). Nicht umkehrbar.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
first_namestring | null Vorname.
last_namestring | null Nachname.
emailstring | null E-Mail-Adresse (eindeutig im Unternehmen, in Kleinbuchstaben gespeichert).
phonestring | null Telefonnummer, wie geschrieben.
account_idinteger | null Die Organisation, zu der die Person gehört (siehe /crm-accounts).
job_titlestring | null Ihre Funktion dort.
citystring | null Ort.
countrystring | null Land, als zweistelliger ISO-Code.
localestring | null Die Sprache, in der sie angesprochen wird (ro, en …).
statuslead | customer | inactive lead, customer oder inactive. Ein Kauf oder eine gewonnene Verkaufschance macht aus einem Interessenten einen Kunden.
sourcewalk_in | website | phone | referral | campaign | event | partner | other | null Woher die Person kam: walk_in, website, phone, referral, campaign, event, partner oder other.
work_unit_idinteger | null Der Standort (Filiale, Hotel, Büro), der sie betreut; leer für keinen.
owner_idinteger | null Das Konto, das sie betreut; beim Anlegen weggelassen: die Person, die den Schlüssel angelegt hat.
tagsarray Schlagwörter (Kleinbuchstaben, höchstens 20).
notestext | null Notizen.
marketing_consentbooleannur lesbar Ob die Person derzeit Marketing zustimmt (nur lesbar – geändert über die Aktion consent).
consent_updated_atdatetime | nullnur lesbar Wann sich die Einwilligung zuletzt geändert hat.
last_activity_atdatetime | nullnur lesbar Wann zuletzt etwas mit ihr getan wurde.
erased_atdatetime | nullnur lesbar Wann ihre Daten auf Wunsch gelöscht wurden (der Eintrag ist dann nur lesbar).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

qstringName, E-Mail oder Telefon enthält dies.
emailstringGenau diese E-Mail (Groß-/Kleinschreibung egal).
phonestringDiese Telefonnummer (nur die Ziffern werden verglichen).
statuslead | customer | inactiveNur mit diesem Status.
work_unit_idintegerNur die dieses Standorts.
owner_idintegerNur die dieses Kontos.
account_idintegerNur die dieser Organisation.
tagstringNur mit diesem Schlagwort.
consentbooleantrue: nur wer Marketing zustimmt; false: nur wer nicht zustimmt.

/api/v1/crm-contacts/{id}/consent: granted (boolean) — true: erteilt; false: widerrufen.; channel (form | verbal | email | import | api | other) — Wie: form, verbal, email, import, api oder other (weggelassen: api).; note (string) — Eine Notiz (zum Beispiel, wo das Formular aufbewahrt wird).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/crm-contacts

{
    "first_name": "Ioana",
    "last_name": "Pop",
    "email": "ioana.pop@example.com",
    "phone": "0722 111 222",
    "account_id": 31,
    "city": "Cluj-Napoca",
    "country": "RO",
    "locale": "ro",
    "status": "customer",
    "source": "walk_in",
    "work_unit_id": 12,
    "owner_id": 17,
    "tags": [
        "loyalty"
    ]
}

Beispielantwort

{
    "data": {
        "id": 120,
        "first_name": "Ioana",
        "last_name": "Pop",
        "email": "ioana.pop@example.com",
        "phone": "0722 111 222",
        "account_id": 31,
        "job_title": null,
        "city": "Cluj-Napoca",
        "country": "RO",
        "locale": "ro",
        "status": "customer",
        "source": "walk_in",
        "work_unit_id": 12,
        "owner_id": 17,
        "tags": [
            "loyalty"
        ],
        "notes": null,
        "marketing_consent": true,
        "consent_updated_at": "2026-05-01T08:00:00Z",
        "last_activity_at": "2026-05-01T08:00:00Z",
        "erased_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kundenorganisationen /crm-accounts

Die Unternehmen und Einrichtungen, an die das Unternehmen verkauft. Der Name ist im Unternehmen eindeutig. Beim Löschen bleiben ihre Kontakte und Verkaufschancen erhalten, ohne die Verknüpfung.

Berechtigungen: crm_accounts:read, crm_accounts:write

Endpunkte

  • GET /api/v1/crm-accounts Liste
  • GET /api/v1/crm-accounts/{id} Ein Eintrag
  • POST /api/v1/crm-accounts Anlegen
  • PATCH /api/v1/crm-accounts/{id} Ändern
  • DELETE /api/v1/crm-accounts/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name (eindeutig im Unternehmen).
registration_numberstring | null Handelsregisternummer.
vat_numberstring | null USt-IdNr.
industrystring | null Branche.
emailstring | null E-Mail-Adresse.
phonestring | null Telefonnummer.
websitestring | null Website.
addressstring | null Adresse.
citystring | null Ort.
countrystring | null Land, als zweistelliger ISO-Code.
work_unit_idinteger | null Der Standort (Filiale, Hotel, Büro), der sie betreut; leer für keinen.
owner_idinteger | null Das Konto, das sie betreut; beim Anlegen weggelassen: die Person, die den Schlüssel angelegt hat.
tagsarray Schlagwörter (Kleinbuchstaben, höchstens 20).
notestext | null Notizen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

qstringName enthält dies.
work_unit_idintegerNur die dieses Standorts.
owner_idintegerNur die dieses Kontos.
tagstringNur mit diesem Schlagwort.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/crm-accounts

{
    "name": "Hotel Sigma SRL",
    "registration_number": "J12/345/2019",
    "vat_number": "RO12345678",
    "industry": "Hospitality",
    "email": "office@sigma.example",
    "phone": "0264 000 111",
    "city": "Cluj-Napoca",
    "country": "RO",
    "work_unit_id": 12,
    "owner_id": 17,
    "tags": [
        "corporate",
        "events"
    ]
}

Beispielantwort

{
    "data": {
        "id": 31,
        "name": "Hotel Sigma SRL",
        "registration_number": "J12/345/2019",
        "vat_number": "RO12345678",
        "industry": "Hospitality",
        "email": "office@sigma.example",
        "phone": "0264 000 111",
        "website": null,
        "address": null,
        "city": "Cluj-Napoca",
        "country": "RO",
        "work_unit_id": 12,
        "owner_id": 17,
        "tags": [
            "corporate",
            "events"
        ],
        "notes": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Vertriebspipelines /crm-pipelines

Die Pipelines, die Verkaufschancen durchlaufen, mit ihren Phasen (in der Anwendung eingerichtet). Jedes Unternehmen hat eine Standard-Pipeline. Eine Phase ist offen (mit der Chance, dass eine Verkaufschance dort gewonnen wird) oder schließt sie als gewonnen oder verloren ab.

Berechtigungen: crm_pipelines:read

Endpunkte

  • GET /api/v1/crm-pipelines Liste
  • GET /api/v1/crm-pipelines/{id} Ein Eintrag

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringnur lesbar Name.
is_defaultbooleannur lesbar Ob neue Verkaufschancen hierher gehen, wenn keine Pipeline angegeben ist.
sortintegernur lesbar Position in Listen.
stagesarraynur lesbar Ihre Phasen in Reihenfolge: id, name, kind (open, won oder lost), probability (0–100) und sort.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Beispielantwort

{
    "data": {
        "id": 1,
        "name": "Sales",
        "is_default": true,
        "sort": 1,
        "stages": [
            {
                "id": 3,
                "name": "Proposal sent",
                "kind": "open",
                "probability": 60,
                "sort": 20
            },
            {
                "id": 5,
                "name": "Won",
                "kind": "won",
                "probability": 100,
                "sort": 40
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Verkaufschancen /crm-deals

Verkäufe, Buchungen oder Verträge, die eine Pipeline durchlaufen. Pipeline und Phase werden beim Anlegen gewählt (weggelassen: die erste offene Phase der Standard-Pipeline); danach wechselt eine Verkaufschance die Phase nur über move, win, lose und reopen. Ihr Status folgt immer ihrer Phase, und closed_at wird beim Gewinnen oder Verlieren gesetzt. Eine gewonnene Verkaufschance macht ihren Kontakt zum Kunden.

Berechtigungen: crm_deals:read, crm_deals:write

Endpunkte

  • GET /api/v1/crm-deals Liste
  • GET /api/v1/crm-deals/{id} Ein Eintrag
  • POST /api/v1/crm-deals Anlegen
  • PATCH /api/v1/crm-deals/{id} Ändern
  • DELETE /api/v1/crm-deals/{id} Löschen
  • POST /api/v1/crm-deals/{id}/move Die Verkaufschance in eine andere Phase verschieben (ihrer Pipeline oder einer anderen – die Verkaufschance wechselt mit).
  • POST /api/v1/crm-deals/{id}/win Die Verkaufschance als gewonnen markieren (die Gewinnphase ihrer Pipeline).
  • POST /api/v1/crm-deals/{id}/lose Die Verkaufschance als verloren markieren (die Verlustphase ihrer Pipeline), mit Grund.
  • POST /api/v1/crm-deals/{id}/reopen Eine abgeschlossene Verkaufschance in die letzte offene Phase ihrer Pipeline zurückholen.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
titlestringerforderlich Was verkauft wird.
pipeline_idinteger Die Pipeline (siehe /crm-pipelines). Nur beim Anlegen festgelegt.
stage_idinteger Die Phase. Nur beim Anlegen festgelegt; danach über die Aktionen.
statusopen | won | lostnur lesbar open, won oder lost – die Art ihrer Phase.
contact_idinteger | null Der Kunde (siehe /crm-contacts).
account_idinteger | null Die Organisation (siehe /crm-accounts).
valuenumber | null Was sie wert ist.
currencystring Die Währung des Werts (ISO-Code); weggelassen: die CRM-Währung des Unternehmens.
expected_close_ondate | null Wann der Abschluss erwartet wird.
closed_atdatetime | nullnur lesbar Wann sie gewonnen oder verloren wurde.
lost_reasonstring | nullnur lesbar Warum sie verloren ging.
sourcewalk_in | website | phone | referral | campaign | event | partner | other | null Woher sie kam (wie bei Kunden).
work_unit_idinteger | null Der Standort (Filiale, Hotel, Büro), der sie betreut; leer für keinen.
owner_idinteger | null Das Konto, das sie betreut; beim Anlegen weggelassen: die Person, die den Schlüssel angelegt hat.
notestext | null Notizen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

statusopen | won | lostNur offene, gewonnene oder verlorene.
pipeline_idintegerNur die dieser Pipeline.
stage_idintegerNur in dieser Phase.
work_unit_idintegerNur die dieses Standorts.
owner_idintegerNur die dieses Kontos.
contact_idintegerNur die dieses Kunden.
account_idintegerNur die dieser Organisation.
closed_sincedateAn oder nach diesem Datum abgeschlossen.
closed_untildateAn oder vor diesem Datum abgeschlossen.

/api/v1/crm-deals/{id}/move: stage_id (integer) — Die Zielphase.

/api/v1/crm-deals/{id}/lose: lost_reason (string) — Warum sie verloren ging.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/crm-deals

{
    "title": "Corporate rates 2027",
    "pipeline_id": 1,
    "stage_id": 3,
    "contact_id": 120,
    "account_id": 31,
    "value": 12500.5,
    "currency": "RON",
    "expected_close_on": "2026-12-15",
    "source": "referral",
    "work_unit_id": 12,
    "owner_id": 17
}

Beispielantwort

{
    "data": {
        "id": 77,
        "title": "Corporate rates 2027",
        "pipeline_id": 1,
        "stage_id": 3,
        "status": "open",
        "contact_id": 120,
        "account_id": 31,
        "value": 12500.5,
        "currency": "RON",
        "expected_close_on": "2026-12-15",
        "closed_at": "2026-05-01T08:00:00Z",
        "lost_reason": null,
        "source": "referral",
        "work_unit_id": 12,
        "owner_id": 17,
        "notes": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kundenaktivitäten /crm-activities

Was mit Kunden getan wurde oder zu tun ist: Anruf, Besprechung, Besuch, E-Mail, Notiz, Aufgabe und Kauf. Eine Aufgabe wartet, bis sie erledigt ist; alles andere ist beim Erfassen erledigt (zu done_at, falls angegeben). Ein Kauf braucht seinen Betrag und macht seinen Kontakt zum Kunden. Eine Aktivität einer Verkaufschance übernimmt deren Kunde, Organisation und Standort, wenn sie nicht angegeben sind.

Berechtigungen: crm_activities:read, crm_activities:write

Endpunkte

  • GET /api/v1/crm-activities Liste
  • GET /api/v1/crm-activities/{id} Ein Eintrag
  • POST /api/v1/crm-activities Anlegen
  • PATCH /api/v1/crm-activities/{id} Ändern
  • DELETE /api/v1/crm-activities/{id} Löschen
  • POST /api/v1/crm-activities/{id}/complete Eine Aufgabe als erledigt markieren (jetzt).
  • POST /api/v1/crm-activities/{id}/reopen Sie wieder als offen markieren (nicht bei Käufen).

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
typecall | meeting | visit | email | task | note | purchaseerforderlich call, meeting, visit, email, task, note oder purchase.
subjectstringerforderlich Kurzbeschreibung.
bodytext | null Details.
contact_idinteger | null Der Kunde.
account_idinteger | null Die Organisation.
deal_idinteger | null Die Verkaufschance, zu der sie gehört.
amountnumber | null Der Betrag eines Kaufs, in der CRM-Währung des Unternehmens (leer bei den anderen Arten).
due_atdatetime | null Wann eine Aufgabe fällig ist.
done_atdatetime | null Wann sie erledigt wurde; leer bei einer noch offenen Aufgabe.
work_unit_idinteger | null Der Standort (Filiale, Hotel, Büro), der sie betreut; leer für keinen.
owner_idinteger | null Das Konto, das sie betreut; beim Anlegen weggelassen: die Person, die den Schlüssel angelegt hat.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

typecall | meeting | visit | email | task | note | purchaseNur diese Art.
work_unit_idintegerNur die dieses Standorts.
owner_idintegerNur die dieses Kontos.
contact_idintegerNur die dieses Kunden.
deal_idintegerNur die dieser Verkaufschance.
donebooleantrue: nur erledigte; false: nur noch offene.
due_beforedatetimeFällig vor diesem Zeitpunkt.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/crm-activities

{
    "type": "purchase",
    "subject": "Receipt 1243",
    "contact_id": 120,
    "amount": 240,
    "due_at": "2026-11-03T09:00:00Z",
    "done_at": "2026-11-02T15:20:00Z",
    "work_unit_id": 12,
    "owner_id": 17
}

Beispielantwort

{
    "data": {
        "id": 530,
        "type": "purchase",
        "subject": "Receipt 1243",
        "body": null,
        "contact_id": 120,
        "account_id": 1,
        "deal_id": 1,
        "amount": 240,
        "due_at": "2026-11-03T09:00:00Z",
        "done_at": "2026-11-02T15:20:00Z",
        "work_unit_id": 12,
        "owner_id": 17,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kundenfeedback /crm-feedback

Was Kunden gesagt haben: Feedback (eine Bewertung von 0–10 – wie wahrscheinlich sie das Unternehmen weiterempfehlen – und/oder ein Kommentar) und Reklamationen. Feedback braucht eine Bewertung oder einen Kommentar. Eine Reklamation bleibt offen, bis sie mit dem Getanen erledigt ist; sie kann wieder geöffnet werden. Die Art wird beim Anlegen festgelegt.

Berechtigungen: crm_feedback:read, crm_feedback:write

Endpunkte

  • GET /api/v1/crm-feedback Liste
  • GET /api/v1/crm-feedback/{id} Ein Eintrag
  • POST /api/v1/crm-feedback Anlegen
  • PATCH /api/v1/crm-feedback/{id} Ändern
  • DELETE /api/v1/crm-feedback/{id} Löschen
  • POST /api/v1/crm-feedback/{id}/resolve Eine Reklamation erledigen, mit Angabe des Getanen.
  • POST /api/v1/crm-feedback/{id}/reopen Eine erledigte Reklamation wieder öffnen.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
kindfeedback | complainterforderlich feedback oder complaint. Nur beim Anlegen festgelegt.
contact_idinteger | null Der Kunde.
account_idinteger | null Die Organisation.
scoreinteger | null Von 0 bis 10.
commenttext | null Was gesagt wurde.
channelin_person | phone | email | website | review_site | survey | other | null Wie es kam: in_person, phone, email, website, review_site, survey oder other.
received_ondate Wann es einging (weggelassen: heute).
statusopen | resolvednur lesbar open (eine noch nicht erledigte Reklamation) oder resolved.
resolved_atdatetime | nullnur lesbar Wann die Reklamation erledigt wurde.
resolutiontext | nullnur lesbar Was dazu getan wurde.
work_unit_idinteger | null Der Standort (Filiale, Hotel, Büro), der sie betreut; leer für keinen.
owner_idinteger | null Das Konto, das sie betreut; beim Anlegen weggelassen: die Person, die den Schlüssel angelegt hat.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

kindfeedback | complaintNur Feedback oder nur Reklamationen.
statusopen | resolvedNur offene oder nur erledigte.
work_unit_idintegerNur die dieses Standorts.
contact_idintegerNur die dieses Kunden.
received_sincedateAn oder nach diesem Datum eingegangen.

/api/v1/crm-feedback/{id}/resolve: resolution (text) — Was getan wurde.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/crm-feedback

{
    "kind": "feedback",
    "contact_id": 120,
    "score": 9,
    "comment": "Quick and friendly service.",
    "channel": "in_person",
    "received_on": "2026-11-02",
    "work_unit_id": 12,
    "owner_id": 17
}

Beispielantwort

{
    "data": {
        "id": 64,
        "kind": "feedback",
        "contact_id": 120,
        "account_id": 1,
        "score": 9,
        "comment": "Quick and friendly service.",
        "channel": "in_person",
        "received_on": "2026-11-02",
        "status": "resolved",
        "resolved_at": "2026-05-01T08:00:00Z",
        "resolution": null,
        "work_unit_id": 12,
        "owner_id": 17,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Flächen im Geschäft und Regalflächen

Partner /merch-partners

Die Hersteller und Marken, deren Kampagnen auf die Präsentationsflächen und in die Regale des Unternehmens kommen: eine Liste für beide Module. Ein Name ist im Unternehmen eindeutig. Schreiben erfordert, dass die Person, die den Schlüssel angelegt hat, „Handelspartner verwalten“ darf.

Berechtigungen: merch_partners:read, merch_partners:write

Endpunkte

  • GET /api/v1/merch-partners Liste
  • GET /api/v1/merch-partners/{id} Ein Eintrag
  • POST /api/v1/merch-partners Anlegen
  • PATCH /api/v1/merch-partners/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name des Partners (eindeutig im Unternehmen).
codestring | null Internes Kürzel.
contact_namestring | null Ansprechperson.
contact_emailstring | null E-Mail der Ansprechperson.
contact_phonestring | null Telefon der Ansprechperson.
notestext | null Notizen.
crm_account_idinteger | null Die passende CRM-Organisation (siehe /crm-accounts), falls vorhanden.
is_activeboolean Ob er neue Kampagnen erhalten kann.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

qstringName enthält den Text.
is_activebooleantrue: nur aktive; false: nur inaktive.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/merch-partners

{
    "name": "Dermalab",
    "code": "DLB",
    "contact_name": "Ana Ionescu",
    "contact_email": "ana@dermalab.example",
    "contact_phone": "0722 000 111",
    "crm_account_id": 31,
    "is_active": true
}

Beispielantwort

{
    "data": {
        "id": 3,
        "name": "Dermalab",
        "code": "DLB",
        "contact_name": "Ana Ionescu",
        "contact_email": "ana@dermalab.example",
        "contact_phone": "0722 000 111",
        "notes": null,
        "crm_account_id": 31,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zonenarten /space-zone-types

Flächen im Geschäft: die Zonenarten, die das Unternehmen an vielen Standorten hat (ein Klapprahmen, ein Thekenaufsteller, ein Totem), mit ihren üblichen Maßen und ihrer Kapazität. Den Monatspreis schreibt nur, wer Beträge sieht.

Berechtigungen: space_zone_types:read, space_zone_types:write

Endpunkte

  • GET /api/v1/space-zone-types Liste
  • GET /api/v1/space-zone-types/{id} Ein Eintrag
  • POST /api/v1/space-zone-types Anlegen
  • PATCH /api/v1/space-zone-types/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name.
descriptiontext | null Beschreibung.
width_cmnumber | null Breite in Zentimetern.
height_cmnumber | null Höhe in Zentimetern.
depth_cmnumber | null Tiefe in Zentimetern.
facesinteger Wie viele Seiten (1 oder 2: A, B).
capacityinteger Wie viele Stück auf eine Seite passen.
capacity_labelstring | null Was die Kapazität zählt (z. B. „A2-Plakate“).
is_displayboolean Ob es eine Präsentationsfläche ist (kann Kampagnen aufnehmen).
monthly_pricenumber | null Der Monatspreis für eine Kapazitätseinheit (Vorschlag für Kampagnenwerte).
is_activeboolean Ob sie noch verwendet wird.
sortinteger Reihenfolge in Listen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue: nur in Verwendung; false: nur ausgemustert.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/space-zone-types

{
    "name": "Ramă click A2",
    "width_cm": 50,
    "height_cm": 70,
    "faces": 2,
    "capacity": 2,
    "capacity_label": "afișe A2",
    "is_display": true,
    "monthly_price": 150,
    "is_active": true,
    "sort": 10
}

Beispielantwort

{
    "data": {
        "id": 2,
        "name": "Ramă click A2",
        "description": null,
        "width_cm": 50,
        "height_cm": 70,
        "depth_cm": 12.5,
        "faces": 2,
        "capacity": 2,
        "capacity_label": "afișe A2",
        "is_display": true,
        "monthly_price": 150,
        "is_active": true,
        "sort": 10,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zonen an Standorten /space-zones

Flächen im Geschäft: die Zonen jedes Standorts (wo, wie groß, wie viel auf jede Seite passt), nur an den Standorten, die die Person gestaltet, die den Schlüssel angelegt hat. Eine Zone bleibt an ihrem Standort. Eine neue Zone einer Art übernimmt für Fehlendes die Maße der Art. Weniger Seiten oder weniger Platz, als ihre laufenden Kampagnen brauchen, wird abgelehnt; eine Zone mit Kampagnen kann nicht gelöscht werden.

Berechtigungen: space_zones:read, space_zones:write

Endpunkte

  • GET /api/v1/space-zones Liste
  • GET /api/v1/space-zones/{id} Ein Eintrag
  • POST /api/v1/space-zones Anlegen
  • PATCH /api/v1/space-zones/{id} Ändern
  • DELETE /api/v1/space-zones/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
work_unit_idintegererforderlich Der Standort – nur beim Anlegen.
zone_type_idinteger | null Die Zonenart (siehe /space-zone-types), falls vorhanden.
namestringerforderlich Name (z. B. „Totem rechts neben der Tür“).
descriptiontext | null Beschreibung.
width_cmnumber | null Breite in Zentimetern.
height_cmnumber | null Höhe in Zentimetern.
depth_cmnumber | null Tiefe in Zentimetern.
area_m2number | null Fläche in Quadratmetern.
facesinteger Wie viele Seiten (1 oder 2).
capacityinteger Wie viele Stück auf eine Seite passen.
capacity_labelstring | null Was die Kapazität zählt.
is_displayboolean Ob es eine Präsentationsfläche ist.
monthly_pricenumber | null Monatspreis (schreibt nur, wer Beträge sieht).
statusactive | unavailable active oder unavailable (vorübergehend).
pin_xnumber | nullnur lesbar Position auf der Skizze des Standorts, Prozent von links (in der Anwendung platziert).
pin_ynumber | nullnur lesbar Position auf der Skizze des Standorts, Prozent von oben.
sortinteger Reihenfolge am Standort.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

work_unit_idintegerNur die dieses Standorts.
zone_type_idintegerNur dieser Art.
statusactive | unavailableNur mit diesem Status.
is_displaybooleantrue: nur Präsentationsflächen.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/space-zones

{
    "work_unit_id": 12,
    "zone_type_id": 2,
    "name": "Ramă click intrare",
    "width_cm": 50,
    "height_cm": 70,
    "faces": 2,
    "capacity": 2,
    "capacity_label": "afișe A2",
    "is_display": true,
    "monthly_price": 150,
    "status": "active",
    "sort": 100
}

Beispielantwort

{
    "data": {
        "id": 41,
        "work_unit_id": 12,
        "zone_type_id": 2,
        "name": "Ramă click intrare",
        "description": null,
        "width_cm": 50,
        "height_cm": 70,
        "depth_cm": 12.5,
        "area_m2": 12.5,
        "faces": 2,
        "capacity": 2,
        "capacity_label": "afișe A2",
        "is_display": true,
        "monthly_price": 150,
        "status": "active",
        "pin_x": 42.5,
        "pin_y": 88,
        "sort": 100,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Möbel und Preise /shelf-fixture-types

Regalflächen: die Arten von Möbeln (eine Gondel, eine Stirnseite, ein Kühlregal) mit der Preisliste – pro Produkt-Facing oder pro Regalmeter, pro Monat. Preise schreibt nur, wer das Recht für Regalpreise hat.

Berechtigungen: shelf_fixture_types:read, shelf_fixture_types:write

Endpunkte

  • GET /api/v1/shelf-fixture-types Liste
  • GET /api/v1/shelf-fixture-types/{id} Ein Eintrag
  • POST /api/v1/shelf-fixture-types Anlegen
  • PATCH /api/v1/shelf-fixture-types/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name.
face_pricenumber | null Preis pro Produkt-Facing und Monat.
meter_pricenumber | null Preis pro Regalmeter und Monat.
is_activeboolean Ob es noch verwendet wird.
sortinteger Reihenfolge in Listen.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

is_activebooleantrue: nur in Verwendung.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/shelf-fixture-types

{
    "name": "Gondolă",
    "face_price": 25,
    "is_active": true,
    "sort": 10
}

Beispielantwort

{
    "data": {
        "id": 1,
        "name": "Gondolă",
        "face_price": 25,
        "meter_price": 12.5,
        "is_active": true,
        "sort": 10,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Planogramme /shelf-planograms

Regalflächen: einmal beschriebene Planogramme – das Möbel, die Maße, die Regalböden von oben nach unten mit dem, was auf jeden passt (Facings oder Zentimeter), und ihrem Preisfaktor. Gesendete Regalböden ersetzen die Liste der Regalböden; ein Regalboden mit Kampagnen kann nicht entfernt werden. Ein Name ist eindeutig.

Berechtigungen: shelf_planograms:read, shelf_planograms:write

Endpunkte

  • GET /api/v1/shelf-planograms Liste
  • GET /api/v1/shelf-planograms/{id} Ein Eintrag
  • POST /api/v1/shelf-planograms Anlegen
  • PATCH /api/v1/shelf-planograms/{id} Ändern

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
namestringerforderlich Name (eindeutig).
codestring | null Internes Kürzel.
fixture_type_idinteger | null Die Möbelart (siehe /shelf-fixture-types).
categorystring | null Produktkategorie.
width_cmnumber | null Breite in Zentimetern.
height_cmnumber | null Höhe in Zentimetern.
depth_cmnumber | null Tiefe in Zentimetern.
capacity_unitfaces | cm faces: Regalkapazität in Produkt-Facings; cm: in Zentimetern.
instructionstext | null Wie es aufgebaut wird (formatierter Text, bereinigt).
is_activeboolean Ob es noch aufgestellt wird.
shelvesarrayerforderlich Die Regalböden, von oben nach unten: [{label, capacity, price_factor}] (die Position folgt der Liste; price_factor schreibt nur, wer Preise sieht).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

fixture_type_idintegerNur mit diesem Möbel.
is_activebooleantrue: nur aktive.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/shelf-planograms

{
    "name": "Capăt de raft vitamine",
    "code": "CR-VIT",
    "fixture_type_id": 2,
    "category": "Suplimente",
    "width_cm": 100,
    "height_cm": 180,
    "capacity_unit": "faces",
    "is_active": true,
    "shelves": [
        {
            "position": 1,
            "label": null,
            "capacity": 8,
            "price_factor": 1.2
        },
        {
            "position": 2,
            "label": "La nivelul ochilor",
            "capacity": 8,
            "price_factor": 1.5
        }
    ]
}

Beispielantwort

{
    "data": {
        "id": 4,
        "name": "Capăt de raft vitamine",
        "code": "CR-VIT",
        "fixture_type_id": 2,
        "category": "Suplimente",
        "width_cm": 100,
        "height_cm": 180,
        "depth_cm": 12.5,
        "capacity_unit": "faces",
        "instructions": null,
        "is_active": true,
        "shelves": [
            {
                "position": 1,
                "label": null,
                "capacity": 8,
                "price_factor": 1.2
            },
            {
                "position": 2,
                "label": "La nivelul ochilor",
                "capacity": 8,
                "price_factor": 1.5
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Aufgestellte Planogramme /shelf-placements

Regalflächen: ein an einem Standort aufgestelltes Planogramm mit eigener Bezeichnung, Notiz und Kosten, nur an den Standorten, die die Person gestaltet, die den Schlüssel angelegt hat. Löschen entfernt es vom Standort: für den Verlauf seiner Kampagnen aufbewahrt oder ganz entfernt, wenn es keine hatte; nie, solange darauf eine Kampagne läuft. Kosten schreibt nur, wer Preise sieht.

Berechtigungen: shelf_placements:read, shelf_placements:write

Endpunkte

  • GET /api/v1/shelf-placements Liste
  • GET /api/v1/shelf-placements/{id} Ein Eintrag
  • POST /api/v1/shelf-placements Anlegen
  • PATCH /api/v1/shelf-placements/{id} Ändern
  • DELETE /api/v1/shelf-placements/{id} Löschen

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
planogram_idintegererforderlich Das Planogramm – nur beim Anlegen.
work_unit_idintegererforderlich Der Standort – nur beim Anlegen.
labelstring | null Eine Bezeichnung, die es von einer weiteren Aufstellung desselben Planogramms am Standort unterscheidet.
statusactive | removednur lesbar active oder removed.
installed_ondate | null Datum der Aufstellung.
removed_ondate | nullnur lesbar Datum der Entfernung.
local_notetext | null Was hier vom üblichen Planogramm abweicht.
setup_costnumber | null Aufbaukosten.
monthly_costnumber | null Monatliche Kosten hier (Pflege, Abschreibung).
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

work_unit_idintegerNur an diesem Standort.
planogram_idintegerNur dieses Planogramm.
statusactive | removedNur mit diesem Status.

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/shelf-placements

{
    "planogram_id": 4,
    "work_unit_id": 12,
    "label": "lângă casă",
    "installed_on": "2026-02-18",
    "monthly_cost": 25
}

Beispielantwort

{
    "data": {
        "id": 88,
        "planogram_id": 4,
        "work_unit_id": 12,
        "label": "lângă casă",
        "status": "active",
        "installed_on": "2026-02-18",
        "removed_on": "2026-05-01",
        "local_note": null,
        "setup_cost": 12.5,
        "monthly_cost": 25,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kampagnen /merch-campaigns

Kampagnen beider Module (module: spaces – Präsentationszonen; shelf – Regalböden von Planogrammen), geschrieben als die Person, die den Schlüssel angelegt hat. Eine Kampagne beginnt als Entwurf: Ihre Standorte (units) und die Regeln, die Plätze darin nennen (rules), werden zu ihren Plätzen. Die Aktion launch prüft den Platz und sendet sie an jeden Standort; cancel stoppt sie. Eine gestartete Kampagne behält Daten und Plätze; nur Text, Partner, Beträge und die Fotopflicht ändern sich. Wert und Kosten schreibt nur, wer Beträge sieht.

Berechtigungen: merch_campaigns:read, merch_campaigns:write

Endpunkte

  • GET /api/v1/merch-campaigns Liste
  • GET /api/v1/merch-campaigns/{id} Ein Eintrag
  • POST /api/v1/merch-campaigns Anlegen
  • PATCH /api/v1/merch-campaigns/{id} Ändern
  • DELETE /api/v1/merch-campaigns/{id} Löschen
  • POST /api/v1/merch-campaigns/{id}/launch Den Entwurf starten: Platz prüfen und an jeden Standort senden.
  • POST /api/v1/merch-campaigns/{id}/cancel Eine gestartete Kampagne stornieren: Sie beginnt nicht, wo sie nicht aufgebaut wurde, und wird abgebaut, wo sie steht.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
modulespaces | shelferforderlich spaces oder shelf – nur beim Anlegen.
titlestringerforderlich Titel der Kampagne.
partner_idinteger | null Der zahlende Partner (siehe /merch-partners); leer: eigene Kampagne des Unternehmens.
instructionstext | null Anleitung zur Umsetzung (formatierter Text, bereinigt).
starts_ondateerforderlich Erster Tag.
ends_ondateerforderlich Letzter Tag.
implement_daysinteger Tage, die ein Standort ab Beginn zum Aufbauen hat.
remove_daysinteger Tage, die ein Standort nach dem Ende zum Abbauen hat.
proof_requiredboolean Ob ein Standort beim Bestätigen Fotos senden muss.
valuenumber | null Was der Partner für die ganze Kampagne zahlt, ohne Umsatzsteuer.
costnumber | null Was sie das Unternehmen kostet (Material, Aufbau), ohne Umsatzsteuer.
currencystringnur lesbar Die Währung der Beträge (aus den Einstellungen des Moduls).
statusdraft | launched | cancellednur lesbar draft, launched oder cancelled.
phasedraft | scheduled | running | ended | cancellednur lesbar draft, scheduled, running, ended oder cancelled.
unitsarray Die Standorte (Standort-IDs), zusammen mit rules.
rulesarray Die Regeln, die Plätze nennen, zusammen mit units. spaces: [{zone_type_id oder zone_id, face (A/B), quantity}]; shelf: [{planogram_id oder placement_id, position (Regalboden, von oben), quantity, products}].
targetsarraynur lesbar Die sich ergebenden Plätze: pro Standort Zone und Seite oder Aufstellung und Regalboden, mit der Menge.
launched_atdatetime | nullnur lesbar Wann gestartet.
cancelled_atdatetime | nullnur lesbar Wann storniert.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

modulespaces | shelfNur dieses Modul.
statusdraft | launched | cancelledNur mit diesem Status.
partner_idintegerNur die dieses Partners.
active_ondateNur die an diesem Tag laufenden (YYYY-MM-DD).

Beispielanfrage

POST https://compania-mea.pulsika.eu/api/v1/merch-campaigns

{
    "module": "shelf",
    "title": "Dermalab – raftul de la ochi",
    "partner_id": 3,
    "starts_on": "2026-11-02",
    "ends_on": "2026-11-30",
    "implement_days": 3,
    "remove_days": 2,
    "proof_required": true,
    "value": 9600,
    "cost": 0,
    "units": [
        12,
        13
    ],
    "rules": [
        {
            "planogram_id": 4,
            "position": 2,
            "quantity": 6,
            "products": "Vitamina D3"
        }
    ]
}

Beispielantwort

{
    "data": {
        "id": 15,
        "module": "shelf",
        "title": "Dermalab – raftul de la ochi",
        "partner_id": 3,
        "instructions": null,
        "starts_on": "2026-11-02",
        "ends_on": "2026-11-30",
        "implement_days": 3,
        "remove_days": 2,
        "proof_required": true,
        "value": 9600,
        "cost": 0,
        "currency": "RON",
        "status": "draft",
        "phase": "scheduled",
        "units": [
            12,
            13
        ],
        "rules": [
            {
                "planogram_id": 4,
                "position": 2,
                "quantity": 6,
                "products": "Vitamina D3"
            }
        ],
        "targets": [
            {
                "work_unit_id": 12,
                "placement_id": 88,
                "shelf_id": 210,
                "quantity": 6,
                "products": "Vitamina D3"
            }
        ],
        "launched_at": "2026-05-01T08:00:00Z",
        "cancelled_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Umsetzung an den Standorten /merch-executions

Eine gestartete Kampagne an einem Standort: wer sie aufbaut und bis wann, ob sie steht, abgelehnt wurde (mit Grund), abgebaut wird oder erledigt ist. Aktionen erfolgen als die Person, die den Schlüssel angelegt hat (die dort umsetzt oder, bei reopen, die Kampagne verantwortet). Fotos werden als Base64-Bilder gesendet; eine Kampagne, die sie verlangt, kann ohne sie nicht bestätigt werden.

Berechtigungen: merch_executions:read, merch_executions:write

Endpunkte

  • GET /api/v1/merch-executions Liste
  • GET /api/v1/merch-executions/{id} Ein Eintrag
  • POST /api/v1/merch-executions/{id}/confirm Bestätigen, dass sie steht (mit Fotos, falls verlangt).
  • POST /api/v1/merch-executions/{id}/refuse Angeben, dass sie nicht aufgebaut werden kann, mit Grund.
  • POST /api/v1/merch-executions/{id}/reopen Einen ablehnenden Standort erneut anfragen (wer die Kampagne verantwortet).
  • POST /api/v1/merch-executions/{id}/removed Bestätigen, dass das Material abgebaut wurde.

Felder

NameTypBeschreibung
idintegernur lesbar Kennung.
campaign_idintegernur lesbar Die Kampagne (siehe /merch-campaigns).
modulespaces | shelfnur lesbar spaces oder shelf (das der Kampagne).
work_unit_idintegernur lesbar Der Standort.
implementer_idinteger | nullnur lesbar Wer sie konkret umsetzt; leer: die Leitung des Standorts.
statuswaiting | pending | done | refused | removing | removed | cancellednur lesbar waiting (noch nicht begonnen), pending (aufzubauen), done (aufgebaut), refused, removing (abzubauen), removed oder cancelled.
latebooleannur lesbar Ob sie nach der Frist aufgebaut wurde oder nicht steht und die Frist vorbei ist.
due_ondate | nullnur lesbar Aufbau bis.
done_atdatetime | nullnur lesbar Wann bestätigt.
done_byinteger | nullnur lesbar Wer bestätigt hat.
notetext | nullnur lesbar Anmerkungen aus der Bestätigung.
refused_atdatetime | nullnur lesbar Wann abgelehnt.
refused_byinteger | nullnur lesbar Wer abgelehnt hat.
refusal_reasontext | nullnur lesbar Warum es nicht möglich ist.
remove_due_ondate | nullnur lesbar Abbau bis.
removed_atdatetime | nullnur lesbar Wann der Abbau bestätigt wurde.
removed_byinteger | nullnur lesbar Wer den Abbau bestätigt hat.
created_atdatetimenur lesbar Angelegt.
updated_atdatetimenur lesbar Zuletzt geändert.

Filter

campaign_idintegerNur die dieser Kampagne.
work_unit_idintegerNur an diesem Standort.
statuswaiting | pending | done | refused | removing | removed | cancelledNur mit diesem Status.
modulespaces | shelfNur dieses Modul.
latebooleantrue: nur verspätete.

/api/v1/merch-executions/{id}/confirm: photos (array) — Fotos: [{name, content_base64}], JPEG/PNG/WebP, je höchstens 10 MB, höchstens 10.; note (text) — Anmerkungen.

/api/v1/merch-executions/{id}/refuse: reason (text) — Der Grund.

/api/v1/merch-executions/{id}/removed: photos (array) — Fotos nach dem Abbau (optional): [{name, content_base64}].

Beispielantwort

{
    "data": {
        "id": 501,
        "campaign_id": 15,
        "module": "shelf",
        "work_unit_id": 12,
        "implementer_id": 17,
        "status": "pending",
        "late": false,
        "due_on": "2026-11-04",
        "done_at": "2026-05-01T08:00:00Z",
        "done_by": 1,
        "note": null,
        "refused_at": "2026-05-01T08:00:00Z",
        "refused_by": 1,
        "refusal_reason": null,
        "remove_due_on": "2026-05-01",
        "removed_at": "2026-05-01T08:00:00Z",
        "removed_by": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Sehen Sie, wie Pulsika für Ihr Team funktioniert

Testen Sie alle Module kostenlos oder vereinbaren Sie eine Vorführung mit unserem Team. Ohne Karte.

oder wir richten ein Testunternehmen mit Ihrer Struktur ein