本文へスキップ
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