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`	Als hierarchischen Baum zurückgeben (1)

Request-Schema

Parameter	Typ	Erforderlich	Beschreibung
`title`	string	Ja	Kategoriename (erforderlich)
`category_key`	string	Nein	Eindeutiger Schlüssel (wird automatisch generiert, wenn nicht angegeben)
`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://your-tenant.plandocket.com/api/v1/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

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

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

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

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

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

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

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

Beispiel-Antwort

200 OK

{
  "data": {
    "categorie_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}