L’API di PaxHelm. I tuoi dati, a portata di mano.
Le attività, i progetti, le note, i promemoria, i solleciti e le persone del tuo spazio, via HTTPS e in JSON, con gli stessi permessi che hai nell’app. Tramite l’API non si elimina nulla.
Autenticazione
Crea un token personale in Impostazioni › Sicurezza › API e invialo con ogni richiesta: Authorization: Bearer pxa_…. Il token si vede una sola volta, può scadere e si revoca in qualsiasi momento. Ambiti: pdash.read, pdash.write.
curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=openElenchi, versioni e limiti
Gli elenchi arrivano a pagine, dai più recenti ai più vecchi. Ogni modifica porta l’expectedVersion letto e risponde 409 se il record è cambiato nel frattempo. Fino a 120 richieste al minuto per token; corpi fino a 64 KB.
Endpoint
Le descrizioni degli endpoint sono in inglese, come il documento OpenAPI.
| Metodo | Percorso | Ambito | Cosa fa |
|---|---|---|---|
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) |
Webhook
PaxHelm avvisa un tuo indirizzo HTTPS quando qualcosa cambia, con una firma HMAC-SHA256 su ogni avviso e nuovi tentativi quando il tuo server non risponde. Eventi:
task.createdtask.updatedtask.completedproject.createdproject.updatedproject.completednote.creatednote.updatednote.archivedreminder.createdreminder.updatedreminder.completedfollow_up.createdfollow_up.updatedfollow_up.closed