跳到正文
PaxHelm

PaxHelm API。 你的数据，触手可及。

通过 HTTPS 和 JSON 访问工作区的任务、项目、笔记、提醒、跟进和联系人，权限与你在应用中相同。通过 API 无法删除任何内容。

OpenAPI 3.1 文档创建令牌

身份验证

在 设置 › 安全 › API 中创建个人令牌，并在每个请求中发送：Authorization: Bearer pxa_…。令牌只显示一次，可设置有效期，并可随时撤销。范围：pdash.read, pdash.write。

curl -H "Authorization: Bearer pxa_…" https://paxhelm.com/api/v1/tasks?status=open

列表、版本与限制

列表按页返回，最新的在前。每次修改都要带上读取到的 expectedVersion；若记录在此期间已变化，则返回 409。每个令牌每分钟最多 120 个请求；请求体最大 64 KB。

端点

端点说明为英文，与 OpenAPI 文档一致。

方法路径范围作用
GET/api/v1/taskspdash.readList tasks, newest first
POST/api/v1/taskspdash.writeCreate a task
GET/api/v1/tasks/{id}pdash.readGet one task
PATCH/api/v1/tasks/{id}pdash.writeChange a task (send only the fields to change, with expectedVersion)
POST/api/v1/tasks/{id}/completepdash.writeComplete a task
POST/api/v1/tasks/{id}/reopenpdash.writeReopen a task
GET/api/v1/projectspdash.readList projects, newest first
POST/api/v1/projectspdash.writeCreate a project
GET/api/v1/projects/{id}pdash.readGet one project
PATCH/api/v1/projects/{id}pdash.writeChange a project (send only the fields to change, with expectedVersion)
GET/api/v1/notespdash.readList notes, newest first
POST/api/v1/notespdash.writeCreate a note
GET/api/v1/notes/{id}pdash.readGet one note
PATCH/api/v1/notes/{id}pdash.writeChange a note (send only the fields to change, with expectedVersion)
GET/api/v1/reminderspdash.readList reminders, newest first
POST/api/v1/reminderspdash.writeCreate a reminder
GET/api/v1/reminders/{id}pdash.readGet one reminder
PATCH/api/v1/reminders/{id}pdash.writeChange a reminder (send only the fields to change, with expectedVersion)
POST/api/v1/reminders/{id}/completepdash.writeComplete a reminder
POST/api/v1/reminders/{id}/snoozepdash.writeSnooze a reminder
GET/api/v1/follow-upspdash.readList follow-ups, newest first
POST/api/v1/follow-upspdash.writeCreate a follow-up
GET/api/v1/follow-ups/{id}pdash.readGet one follow-up
PATCH/api/v1/follow-ups/{id}pdash.writeChange a follow-up (send only the fields to change, with expectedVersion)
POST/api/v1/follow-ups/{id}/closepdash.writeClose a follow-up
GET/api/v1/peoplepdash.readList people, newest first
POST/api/v1/peoplepdash.writeCreate a person
GET/api/v1/people/{id}pdash.readGet one person
PATCH/api/v1/people/{id}pdash.writeChange a person (send only the fields to change, with expectedVersion)

Webhook

有内容变化时，PaxHelm 会通知你的 HTTPS 地址；每条通知都带 HMAC-SHA256 签名，服务器无响应时会重试。事件：

  • task.created
  • task.updated
  • task.completed
  • project.created
  • project.updated
  • project.completed
  • note.created
  • note.updated
  • note.archived
  • reminder.created
  • reminder.updated
  • reminder.completed
  • follow_up.created
  • follow_up.updated
  • follow_up.closed