Zum Inhalt springen
PaxHelm

Die PaxHelm-API. Ihre Daten in Reichweite.

Die Aufgaben, Projekte, Notizen, Erinnerungen, Nachfassaktionen und Personen Ihres Arbeitsbereichs über HTTPS und JSON, mit denselben Rechten wie in der App. Über die API wird nichts gelöscht.

OpenAPI-3.1-DokumentToken erstellen

Authentifizierung

Erstellen Sie unter Einstellungen › Sicherheit › API ein persönliches Token und senden Sie es mit jeder Anfrage: Authorization: Bearer pxa_…. Das Token wird einmal angezeigt, kann ablaufen und lässt sich jederzeit widerrufen. Bereiche: pdash.read, pdash.write.

curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=open

Listen, Versionen und Grenzen

Listen kommen seitenweise, die neuesten zuerst. Jede Änderung trägt die gelesene expectedVersion und antwortet mit 409, wenn sich der Eintrag inzwischen geändert hat. Bis zu 120 Anfragen pro Minute und Token; Anfragekörper bis 64 KB.

Endpunkte

Die Beschreibungen der Endpunkte sind auf Englisch, wie das OpenAPI-Dokument.

MethodePfadBereichWas er tut
GET/api/v1/taskspdash.readList tasks, newest first
POST/api/v1/taskspdash.writeCreate a task
GET/api/v1/tasks/{id}pdash.readGet one task
PATCH/api/v1/tasks/{id}pdash.writeChange a task (send only the fields to change, with expectedVersion)
POST/api/v1/tasks/{id}/completepdash.writeComplete a task
POST/api/v1/tasks/{id}/reopenpdash.writeReopen a task
GET/api/v1/projectspdash.readList projects, newest first
POST/api/v1/projectspdash.writeCreate a project
GET/api/v1/projects/{id}pdash.readGet one project
PATCH/api/v1/projects/{id}pdash.writeChange a project (send only the fields to change, with expectedVersion)
GET/api/v1/notespdash.readList notes, newest first
POST/api/v1/notespdash.writeCreate a note
GET/api/v1/notes/{id}pdash.readGet one note
PATCH/api/v1/notes/{id}pdash.writeChange a note (send only the fields to change, with expectedVersion)
GET/api/v1/reminderspdash.readList reminders, newest first
POST/api/v1/reminderspdash.writeCreate a reminder
GET/api/v1/reminders/{id}pdash.readGet one reminder
PATCH/api/v1/reminders/{id}pdash.writeChange a reminder (send only the fields to change, with expectedVersion)
POST/api/v1/reminders/{id}/completepdash.writeComplete a reminder
POST/api/v1/reminders/{id}/snoozepdash.writeSnooze a reminder
GET/api/v1/follow-upspdash.readList follow-ups, newest first
POST/api/v1/follow-upspdash.writeCreate a follow-up
GET/api/v1/follow-ups/{id}pdash.readGet one follow-up
PATCH/api/v1/follow-ups/{id}pdash.writeChange a follow-up (send only the fields to change, with expectedVersion)
POST/api/v1/follow-ups/{id}/closepdash.writeClose a follow-up
GET/api/v1/peoplepdash.readList people, newest first
POST/api/v1/peoplepdash.writeCreate a person
GET/api/v1/people/{id}pdash.readGet one person
PATCH/api/v1/people/{id}pdash.writeChange a person (send only the fields to change, with expectedVersion)

Webhooks

PaxHelm benachrichtigt eine HTTPS-Adresse von Ihnen, wenn sich etwas ändert, mit einer HMAC-SHA256-Signatur auf jeder Nachricht und neuen Versuchen, wenn Ihr Server nicht antwortet. Ereignisse:

  • task.created
  • task.updated
  • task.completed
  • project.created
  • project.updated
  • project.completed
  • note.created
  • note.updated
  • note.archived
  • reminder.created
  • reminder.updated
  • reminder.completed
  • follow_up.created
  • follow_up.updated
  • follow_up.closed