Service Categories API

Leistungskategorien (Service Categories) gruppieren Services für Auswertungen und Übersichten (z.B. "Beratung", "Entwicklung", "Administration"). Die Zuordnung eines Services zu einer Kategorie ist optional.

ServiceCategory-Objekt

{
  "id": 3,
  "name": "Beratung",
  "created_at": "2026-04-09T16:00:00.000000Z",
  "updated_at": "2026-04-09T16:00:00.000000Z"
}

Attribute

Feld	Typ	Beschreibung
id	integer	Eindeutige Kategorie-ID
name	string	Name der Leistungskategorie (erforderlich, max. 255 Zeichen)
created_at	datetime	Erstellungsdatum
updated_at	datetime	Datum der letzten Aktualisierung

Endpoints

Alle Leistungskategorien auflisten

GET /companies/{company}/service-categories

Ruft alle Leistungskategorien der Firma alphabetisch nach name sortiert ab. Der Endpoint ist nicht paginiert — es werden alle Kategorien in einem Response zurückgegeben.

Response

{
  "data": [
    {
      "id": 3,
      "name": "Beratung",
      "created_at": "2026-04-09T16:00:00.000000Z",
      "updated_at": "2026-04-09T16:00:00.000000Z"
    },
    {
      "id": 1,
      "name": "Entwicklung",
      "created_at": "2026-04-09T15:55:00.000000Z",
      "updated_at": "2026-04-09T15:55:00.000000Z"
    }
  ]
}

Beispiel

curl -X GET \
     -H "Authorization: Bearer 1|abcdef123456789..." \
     "https://app.milkee.ch/api/v2/companies/123/service-categories"

Einzelne Leistungskategorie abrufen

GET /companies/{company}/service-categories/{serviceCategory}

Response

{
  "data": {
    "id": 3,
    "name": "Beratung",
    "created_at": "2026-04-09T16:00:00.000000Z",
    "updated_at": "2026-04-09T16:00:00.000000Z"
  }
}

Beispiel

curl -X GET \
     -H "Authorization: Bearer 1|abcdef123456789..." \
     "https://app.milkee.ch/api/v2/companies/123/service-categories/3"

Leistungskategorie erstellen

POST /companies/{company}/service-categories

Request Body

Feld	Typ	Erforderlich	Beschreibung
name	string	Ja	Name der Kategorie (max. 255 Zeichen)

Response

HTTP/1.1 201 Created

{
  "data": {
    "id": 3,
    "name": "Beratung",
    "created_at": "2026-04-09T16:00:00.000000Z",
    "updated_at": "2026-04-09T16:00:00.000000Z"
  }
}

Beispiel

curl -X POST \
     -H "Authorization: Bearer 1|abcdef123456789..." \
     -H "Content-Type: application/json" \
     -d '{"name": "Beratung"}' \
     "https://app.milkee.ch/api/v2/companies/123/service-categories"

Leistungskategorie aktualisieren

PUT /companies/{company}/service-categories/{serviceCategory}

Request Body

Feld	Typ	Beschreibung
name	string	Neuer Name (max. 255 Zeichen)

Response

Gibt das aktualisierte Kategorie-Objekt zurück.

Beispiel

curl -X PUT \
     -H "Authorization: Bearer 1|abcdef123456789..." \
     -H "Content-Type: application/json" \
     -d '{"name": "Strategie-Beratung"}' \
     "https://app.milkee.ch/api/v2/companies/123/service-categories/3"

Leistungskategorie löschen

DELETE /companies/{company}/service-categories/{serviceCategory}

Löscht eine Leistungskategorie permanent.

Services bleiben erhalten

Services, die der gelöschten Kategorie zugeordnet waren, behalten ihren Eintrag — ihre service_category_id wird automatisch auf null gesetzt.

Response

HTTP/1.1 204 No Content

Beispiel

curl -X DELETE \
     -H "Authorization: Bearer 1|abcdef123456789..." \
     "https://app.milkee.ch/api/v2/companies/123/service-categories/3"

Fehlerbehandlung

422 Validation Error

{
  "message": "The given data was invalid.",
  "errors": {
    "name": ["Der Name ist erforderlich."]
  }
}

Best Practices

Konsistente Benennung

Wählen Sie kurze, klare Kategorienamen, die auf Auswertungen gut lesbar sind (z.B. "Beratung", "Entwicklung", "Administration"). Kategorien sind firmenweit sichtbar und werden in Reports verwendet.

Optional, nicht erzwungen

Die Zuordnung einer Kategorie zu einem Service ist optional. Verwenden Sie Kategorien nur, wenn die Gruppierung für die Auswertung tatsächlich Mehrwert bietet — andernfalls reicht die Service-Ebene aus.