İçeriğe atla
PaxHelm

PaxHelm API. Verileriniz elinizin altında.

Çalışma alanınızın görevleri, projeleri, notları, hatırlatıcıları, takipleri ve kişileri HTTPS ve JSON ile, uygulamadaki izinlerinizle. API üzerinden hiçbir şey silinmez.

OpenAPI 3.1 belgesiToken oluştur

Kimlik doğrulama

Ayarlar › Güvenlik › API bölümünde kişisel bir token oluşturun ve her istekte gönderin: Authorization: Bearer pxa_…. Token bir kez gösterilir, süresi dolabilir ve istediğiniz zaman iptal edilebilir. Kapsamlar: pdash.read, pdash.write.

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

Listeler, sürümler ve sınırlar

Listeler sayfalar hâlinde, en yeniden eskiye gelir. Her değişiklik okunan expectedVersion değerini taşır ve kayıt bu arada değiştiyse 409 döner. Token başına dakikada en fazla 120 istek; gövdeler en fazla 64 KB.

Uç noktalar

Uç noktaların açıklamaları, OpenAPI belgesi gibi İngilizcedir.

YöntemYolKapsamNe yapar
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’lar

PaxHelm bir şey değiştiğinde HTTPS adresinize haber verir; her bildirimde bir HMAC-SHA256 imzası bulunur ve sunucunuz yanıt vermezse yeniden dener. Olaylar:

  • 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