PlanDocket

API-Referenz

Business+

Vollständige Dokumentation aller REST API Endpunkte.

Basis-URL

https://ihr-mandant.plandocket.com/api/v1

Maschinenlesbare Beschreibung aller Endpunkte (OpenAPI 3.1) für Client-Generatoren, Postman und Swagger UI.

Adresse der OpenAPI-Datei

https://docs.plandocket.com/de/openapi.json

Kernressourcen

Grundlegende Entitäten für Event-Management.

Ressource Beschreibung Bereiche
/api/v1/events Events
events
/api/v1/contacts Kontakte
contacts
/api/v1/participants Teilnehmer
participants
/api/v1/applications Bewerbungen
applications
/api/v1/categories Kategorien
categories

Finanzen

Rechnungs- und Zahlungsverwaltung.

Ressource Beschreibung Bereiche
/api/v1/invoices Rechnungen
invoices
/api/v1/credit-notes Gutschriften
invoices
/api/v1/payments Zahlungen
payments
/api/v1/refunds Erstattungen
payments
/api/v1/payment-reminders Zahlungserinnerungen
invoices

Standverwaltung

Stände, Reservierungen und Lagepläne.

Ressource Beschreibung Bereiche
/api/v1/booths Stände
booths
/api/v1/booth-types Standtypen
plans
/api/v1/booth-reservations Stand-Reservierungen
booths
/api/v1/plans Lagepläne
plans

Dienstleistungen

Zusätzliche Services und Bestellungen.

Ressource Beschreibung Bereiche
/api/v1/services Dienstleistungen
services
/api/v1/service-categories Dienstleistungskategorien
services
/api/v1/event-services Event-Dienstleistungen
services
/api/v1/service-orders Dienstleistungsbestellungen
service_orders

Inhalte

Dokumente, Einreichungen und Aufgaben.

Ressource Beschreibung Bereiche
/api/v1/documents Dokumente
documents
/api/v1/submissions Einreichungen
submissions
/api/v1/submission-types Einreichungstypen
submissions
/api/v1/list-templates Listenvorlagen
lists
/api/v1/list-entries Listeneinträge
lists
/api/v1/tasks Aufgaben
tasks
/api/v1/notes Notizen
contacts applications participants invoices events

Operationen

Check-Ins, Zeitpläne und Kalender.

Ressource Beschreibung Bereiche
/api/v1/check-ins Check-Ins
checkins
/api/v1/schedules Zeitpläne
schedules
/api/v1/calendar-feed Kalender
calendar-feed

Anpassung

Benutzerdefinierte Felder und Newsletter.

Ressource Beschreibung Bereiche
/api/v1/custom-fields Benutzerdefinierte Felder
custom_fields
/api/v1/newsletter Newsletter
newsletter

Integration

Webhooks, Import und Berichte.

Ressource Beschreibung Bereiche
/api/v1/webhooks Webhooks
webhooks
/api/v1/bulk-import Massenimport
contacts participants
/api/v1/reports Berichte
reports
/api/v1/audit-log Aktivitätsprotokoll
audit

Allgemeine Muster

Ressourcen auflisten

GET /api/v1/{resource}?page=1&per_page=20

Abrufen einer paginierten Liste von Ressourcen.

Einzelne Ressource

GET /api/v1/{resource}/{id}

Abrufen einer einzelnen Ressource nach ID.

Ressource erstellen

POST /api/v1/{resource}

Erstellen einer neuen Ressource.

Ressource aktualisieren

PUT /api/v1/{resource}/{id}

Aktualisieren einer bestehenden Ressource.

API Version v1.0