Aller au contenu
PaxHelm

L’API de PaxHelm. Vos données, à portée de main.

Les tâches, projets, notes, rappels, relances et personnes de votre espace, en HTTPS et JSON, avec les mêmes droits que dans l’application. Rien ne se supprime par l’API.

Document OpenAPI 3.1Créer un jeton

Authentification

Créez un jeton personnel dans Réglages › Sécurité › API et envoyez-le à chaque requête : Authorization: Bearer pxa_…. Le jeton s’affiche une seule fois, peut expirer et se révoque à tout moment. Portées : pdash.read, pdash.write.

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

Listes, versions et limites

Les listes arrivent par pages, des plus récentes aux plus anciennes. Chaque modification porte l’expectedVersion lu et répond 409 si l’enregistrement a changé entre-temps. Jusqu’à 120 requêtes par minute et par jeton ; corps jusqu’à 64 Ko.

Points d’accès

Les descriptions des points d’accès sont en anglais, comme le document OpenAPI.

MéthodeCheminPortéeCe qu’il fait
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 prévient une adresse HTTPS à vous quand quelque chose change, avec une signature HMAC-SHA256 sur chaque avis et de nouvelles tentatives quand votre serveur ne répond pas. Événements :

  • 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