PaxHelms API. Dina data inom räckhåll.
Arbetsytans uppgifter, projekt, anteckningar, påminnelser, uppföljningar och personer över HTTPS och JSON, med samma behörigheter som i appen. Inget kan raderas via API:t.
Autentisering
Skapa en personlig token under Inställningar › Säkerhet › API och skicka den med varje anrop: Authorization: Bearer pxa_…. Token visas en gång, kan ha ett utgångsdatum och kan återkallas när som helst. Omfång: pdash.read, pdash.write.
curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=openListor, versioner och gränser
Listor kommer sidvis, nyast först. Varje ändring skickar med den lästa expectedVersion och svarar 409 om posten har ändrats under tiden. Upp till 120 anrop per minut och token; innehåll upp till 64 KB.
Slutpunkter
Beskrivningarna av slutpunkterna är på engelska, precis som OpenAPI-dokumentet.
| Metod | Sökväg | Omfång | Vad den gör |
|---|---|---|---|
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 meddelar en HTTPS-adress som du anger när något ändras, med en HMAC-SHA256-signatur på varje meddelande och nya försök när din server inte svarar. Händelser:
task.createdtask.updatedtask.completedproject.createdproject.updatedproject.completednote.creatednote.updatednote.archivedreminder.createdreminder.updatedreminder.completedfollow_up.createdfollow_up.updatedfollow_up.closed