La API de PaxHelm. Sus datos, a su alcance.
Las tareas, proyectos, notas, recordatorios, seguimientos y personas de su espacio, por HTTPS y en JSON, con los mismos permisos que tiene en la aplicación. Nada se borra a través de la API.
Autenticación
Cree un token personal en Configuración › Seguridad › API y envíelo en cada petición: Authorization: Bearer pxa_…. El token se muestra una vez, puede caducar y se revoca cuando quiera. Ámbitos: pdash.read, pdash.write.
curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=openListas, versiones y límites
Las listas llegan por páginas, de las más recientes a las más antiguas. Cada cambio lleva el expectedVersion leído y responde 409 si el registro cambió mientras tanto. Hasta 120 peticiones por minuto y token; cuerpos de hasta 64 KB.
Endpoints
Las descripciones de los endpoints están en inglés, como el documento OpenAPI.
| Método | Ruta | Ámbito | Qué hace |
|---|---|---|---|
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 avisa a una dirección HTTPS suya cuando algo cambia, con una firma HMAC-SHA256 en cada aviso y reintentos cuando su servidor no responde. Eventos:
task.createdtask.updatedtask.completedproject.createdproject.updatedproject.completednote.creatednote.updatednote.archivedreminder.createdreminder.updatedreminder.completedfollow_up.createdfollow_up.updatedfollow_up.closed