De PaxHelm-API. Je gegevens binnen handbereik.
De taken, projecten, notities, herinneringen, opvolgingen en personen van je werkruimte via HTTPS en JSON, met dezelfde rechten als in de app. Via de API wordt niets verwijderd.
Authenticatie
Maak een persoonlijk token in Instellingen › Beveiliging › API en stuur het mee met elk verzoek: Authorization: Bearer pxa_…. Het token wordt één keer getoond, kan verlopen en is altijd in te trekken. Bereiken: pdash.read, pdash.write.
curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=openLijsten, versies en limieten
Lijsten komen in pagina’s, nieuwste eerst. Elke wijziging bevat de gelezen expectedVersion en antwoordt 409 als het record intussen veranderd is. Tot 120 verzoeken per minuut per token; bodies tot 64 KB.
Endpoints
De beschrijvingen van de endpoints zijn in het Engels, zoals het OpenAPI-document.
| Methode | Pad | Bereik | Wat het doet |
|---|---|---|---|
GET | /api/v1/tasks | pdash.read | List tasks, newest first |
POST | /api/v1/tasks | pdash.write | Create a task |
GET | /api/v1/tasks/{id} | pdash.read | Get one task |
PATCH | /api/v1/tasks/{id} | pdash.write | Change a task (send only the fields to change, with expectedVersion) |
POST | /api/v1/tasks/{id}/complete | pdash.write | Complete a task |
POST | /api/v1/tasks/{id}/reopen | pdash.write | Reopen a task |
GET | /api/v1/projects | pdash.read | List projects, newest first |
POST | /api/v1/projects | pdash.write | Create a project |
GET | /api/v1/projects/{id} | pdash.read | Get one project |
PATCH | /api/v1/projects/{id} | pdash.write | Change a project (send only the fields to change, with expectedVersion) |
GET | /api/v1/notes | pdash.read | List notes, newest first |
POST | /api/v1/notes | pdash.write | Create a note |
GET | /api/v1/notes/{id} | pdash.read | Get one note |
PATCH | /api/v1/notes/{id} | pdash.write | Change a note (send only the fields to change, with expectedVersion) |
GET | /api/v1/reminders | pdash.read | List reminders, newest first |
POST | /api/v1/reminders | pdash.write | Create a reminder |
GET | /api/v1/reminders/{id} | pdash.read | Get one reminder |
PATCH | /api/v1/reminders/{id} | pdash.write | Change a reminder (send only the fields to change, with expectedVersion) |
POST | /api/v1/reminders/{id}/complete | pdash.write | Complete a reminder |
POST | /api/v1/reminders/{id}/snooze | pdash.write | Snooze a reminder |
GET | /api/v1/follow-ups | pdash.read | List follow-ups, newest first |
POST | /api/v1/follow-ups | pdash.write | Create a follow-up |
GET | /api/v1/follow-ups/{id} | pdash.read | Get one follow-up |
PATCH | /api/v1/follow-ups/{id} | pdash.write | Change a follow-up (send only the fields to change, with expectedVersion) |
POST | /api/v1/follow-ups/{id}/close | pdash.write | Close a follow-up |
GET | /api/v1/people | pdash.read | List people, newest first |
POST | /api/v1/people | pdash.write | Create a person |
GET | /api/v1/people/{id} | pdash.read | Get one person |
PATCH | /api/v1/people/{id} | pdash.write | Change a person (send only the fields to change, with expectedVersion) |
Webhooks
PaxHelm meldt het aan een HTTPS-adres van jou als er iets verandert, met een HMAC-SHA256-handtekening op elke melding en nieuwe pogingen als je server niet antwoordt. Gebeurtenissen:
task.createdtask.updatedtask.completedproject.createdproject.updatedproject.completednote.creatednote.updatednote.archivedreminder.createdreminder.updatedreminder.completedfollow_up.createdfollow_up.updatedfollow_up.closed