Kategorien - API-Referenz - PlanDocket Dokumentation

Endpunkte

GET


                    /api/v1/categories

Alle Kategorien auflisten

GET


                    /api/v1/categories/{id}

Einzelne Kategorie abrufen

POST


                    /api/v1/categories

Neue Kategorie erstellen

PUT/PATCH


                    /api/v1/categories/{id}

Kategorie aktualisieren

DELETE


                    /api/v1/categories/{id}

Kategorie löschen

Abfrageparameter

Parameter	Beschreibung
`hierarchical`	Den vollständigen Kategoriebaum ohne Paginierung zurückgeben (1); ohne den Parameter ist die flache Liste paginiert (page, per_page)
`page`	Seitennummer (Standard: 1)
`per_page`	Ergebnisse pro Seite (Standard: 25, max. 100)

Request-Schema

Parameter	Typ	Erforderlich	Beschreibung
`title`	string	Ja	Kategoriename (erforderlich)
`category_key`	string	Nein	Eindeutiger Schlüssel: Kleinbuchstaben, Ziffern, "_" und "-", max. 100 Zeichen (wird automatisch generiert, wenn nicht angegeben). Bei einer Änderung per PUT/PATCH werden alle Verweise (Formulare, Bereiche, Felder, Dienstleistungen usw.) auf den neuen Schlüssel umgestellt; beim Löschen wird der Schlüssel aus diesen Einschränkungen entfernt (ein Datensatz ohne verbleibende Kategorie gilt danach für alle Kategorien). Ein bereits vergebener Schlüssel ergibt 422
`parent_category_id`	integer	Nein	Übergeordnete Kategorie-ID für Verschachtelung
`content`	string	Nein	Kategoriebeschreibung oder Inhalt
`event_keys`	array	Nein	Array von Event-Schlüsseln zur Zuordnung
`is_visible`	boolean	Nein	Ob die Kategorie sichtbar ist (Standard: true)
`applicant_visibility`	string	Nein	Sichtbarkeit für Bewerber (selectable, container, admin_only)
`account_access_enabled`	boolean	Nein	Ob die Kategorie im Benutzerportal verfügbar ist (Standard: true)
`sort_order`	integer	Nein	Anzeigereihenfolge (Standard: 0)

Response-Schema

Feld	Typ
`id`	integer
`category_key`	string\|null
`title`	string
`content`	string\|null
`parent_category_id`	integer
`event_keys`	array\|null
`is_visible`	boolean
`applicant_visibility`	string
`account_access_enabled`	boolean
`sort_order`	integer
`level`	integer\|null
`created_at`	string
`updated_at`	string

Codebeispiele

curl -X GET "https://ihr-mandant.plandocket.com/api/v1/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://ihr-mandant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/categories',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://ihr-mandant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/categories`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://ihr-mandant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
}

response = requests.get(f'{base_url}/api/v1/categories', headers=headers)
data = response.json()
print(data)

Beispiel-Antwort

200 OK

{
    "data": [
        {
            "id": 1,
            "category_key": "string",
            "title": "string",
            "content": "string",
            "parent_category_id": 1,
            "event_keys": [],
            "is_visible": true,
            "applicant_visibility": "string",
            "account_access_enabled": true,
            "sort_order": 1,
            "level": 1,
            "created_at": "2026-01-15T10:00:00+01:00",
            "updated_at": "2026-01-15T10:00:00+01:00"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 25,
        "total": 1,
        "total_pages": 1
    }
}