The PaxHelm API. Your data, within reach.
Your workspace's tasks, projects, notes, reminders, follow-ups and people over HTTPS and JSON, with the same permissions you have in the app. Nothing can be deleted through the API.
Authentication
Create a personal token in Settings › Security › API and send it with every request: Authorization: Bearer pxa_…. The token is shown once, can expire and can be revoked at any time. Scopes: pdash.read, pdash.write.
curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=openLists, versions and limits
Lists come in pages, newest first. Every change carries the expectedVersion you read and answers 409 when the record changed meanwhile. Up to 120 requests a minute per token; bodies up to 64 KB.
Endpoints
| Method | Path | Scope | What it does |
|---|---|---|---|
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 notifies an HTTPS address of yours when something changes, with an HMAC-SHA256 signature on every notice and retries when your server does not answer. Events:
task.createdtask.updatedtask.completedproject.createdproject.updatedproject.completednote.creatednote.updatednote.archivedreminder.createdreminder.updatedreminder.completedfollow_up.createdfollow_up.updatedfollow_up.closed