Mit der API verbindest du pgday mit deinen eigenen Tools und Automationen. So kannst du Leads programmatisch lesen oder schreiben und pgday in bestehende Abläufe einbinden. Der API-Zugang ist im Pro-Plan verfügbar und wird von Admins verwaltet.
API-Key erstellen
- Öffne Einstellungen → Integrationen, KI & Tarif.
- Gib deinem Key einen sprechenden Namen (z. B. „CRM Integration“).
- Wähle ausdrücklich die Organisation oder einen Space. Ein Space-Key greift nur auf Events und Leads dieses Spaces zu; ein Organisations-Key kann die Events seiner Organisation über mehrere Spaces hinweg nutzen.
- Wähle die benötigten Berechtigungen: Leads, Events oder Leaderboards lesen und optional Leads anlegen/ändern. Anfangs ist nur das Lesen von Leads ausgewählt.
- Klicke auf API-Key erstellen.
- Kopiere den Key sofort und speichere ihn sicher — er wird nur einmal vollständig angezeigt. Blende ihn anschließend über Verstanden, Key gesichert aus.
Die Liste zeigt Name, Organisation oder Space, Berechtigungen, kurzen Key-Anfang und Erstellungsdatum, nie den vollständigen Key. Wird ein Space gelöscht, wird der Key nicht organisationsweit: Die Liste kennzeichnet den Space als nicht mehr verfügbar. Erstelle zum Ändern von Geltungsbereich oder Berechtigungen einen Ersatz und widerrufe den alten Key.
Falls die Erstellung nicht bestätigt werden kann, prüfe vor einem neuen Versuch die aktualisierte Liste. Der Key könnte bereits angelegt sein; widerrufe ihn, wenn du seinen vollständigen Wert nicht erhalten hast.
Sicherheit
- Behandle den Key wie ein Passwort.
- Teile ihn niemals in öffentlichem Code, Chats, Screenshots oder Tickets.
- Füge ihn nie an unvertrauenswürdigen Stellen ein.
- Bei Verdacht auf Missbrauch: Key widerrufen und einen neuen erstellen.
Key widerrufen
Du kannst jeden Key jederzeit in den Integrationen widerrufen. Ein widerrufener Key wird sofort ungültig — alle Integrationen, die ihn nutzen, funktionieren danach nicht mehr. Erstelle bei Bedarf einfach einen neuen Key.
Admins und Game Master können die Liste und den Widerruf weiterhin nutzen, wenn API-Funktion oder Tarif nicht mehr aktiv sind. Neue Keys benötigen einen aktiven API-Zugang. Ohne Verwaltungsrolle entfällt auch der Zugriff auf die Key-Verwaltung.
Wofür nutzen
- Eigene Integrationen mit deinen Tools.
- Datenexport und -import von Leads.
- Automationen, die Leads anlegen oder aktualisieren.
Für die fertige CRM-Anbindung musst du nicht selbst programmieren — nutze dafür die Zoho-CRM-Integration.
Leads anlegen und aktualisieren
Ein Key mit Schreibzugriff benötigt die Berechtigung leads:write. Sende für POST /leads den Firmennamen company_name, die vollständige user_email des zuständigen Vertriebsmitarbeiters und eine ausdrückliche event_id. Die E-Mail muss zu einem aktuellen Mitglied mit Zugang zu diesem Event und dessen Space gehören. Anzeigename oder E-Mail-Präfix reichen nicht. Fest zugeordnete Space-Teilnehmer müssen genau diesem Event beigetreten sein.
Verwende eine aktive Event-Stage als meeting_type (Standard: outreach) und optional einen aktiven channel. Die Punkte ergeben sich aus den Stage-, Kanal- und Kaltkontakt-Regeln dieses Events. Sende keine eigenen Werte für points, tenant_id, space_id oder user_id. Bei Telefonkanälen gibt phone_contact: "reached" den Kanalbonus; "not_reached" erfordert eine Outreach-Stage und gibt keinen Telefonbonus. Ohne Angabe zum Telefonkontakt gibt es keinen Telefonbonus.
Mit PUT /leads/{id} kannst du Kontaktdaten, Notizen, Status, Stage, Kanal und Temperatur ändern. Zuständiger Mitarbeiter, Organisation, Event und Space bleiben fest. Reine Notizänderungen erhalten die historischen Punkte, auch bei inzwischen deaktivierten Stages. Bei geänderten Bewertungsfeldern gelten die aktuellen Event-Regeln; eine Neuberechnung für Telefonkanäle benötigt eine ausdrückliche phone_contact-Angabe.
Eine Antwort mit 409 bedeutet, dass eine gleichzeitige Änderung den Schreibvorgang zurückgerollt hat. Prüfe bei einem Verbindungsabbruch oder einer 503-Antwort mit unbestätigtem Schreibvorgang zuerst die Leadliste, bevor du einen Anlegeversuch wiederholst. So vermeidest du Duplikate.
Hinweis
Der API-Zugang benötigt den Pro-Plan. Wie du deinen Plan verwaltest, liest du unter Pläne & Abrechnung; eine Übersicht der Tarife findest du auf der Preisseite. Wie deine Daten geschützt sind, steht unter Daten & Datenschutz.
Entwickler-Ressourcen
Nutze den Entwickler-Leitfaden, die Produktions-OpenAPI, den Berechtigungskatalog und den Onboarding-Status. Die kostenlose synthetische, schreibgeschützte Sandbox benötigt weder Konto noch Schlüssel. Neue produktive Organisationen benötigen derzeit Pilotzugang; die konfigurierte Testphase ist nicht öffentlich freigegeben.
Offizielle CLI
Installiere sie mit brew install kkuckein/pgday/pgday unter macOS oder Linux und führe anschließend pgday events list --sandbox ohne Zugangsdaten aus. Die CLI-Anleitung verlinkt das offizielle Homebrew-Tap, versionierte Downloads und die Einrichtung von Produktionsschlüsseln.