Przejdź do treści
PaxHelm

API PaxHelm. Twoje dane pod ręką.

Zadania, projekty, notatki, przypomnienia, sprawy w toku i osoby z Twojej przestrzeni przez HTTPS i JSON, z tymi samymi uprawnieniami co w aplikacji. Przez API nic się nie usuwa.

Dokument OpenAPI 3.1Utwórz token

Uwierzytelnianie

Utwórz token osobisty w Ustawienia › Bezpieczeństwo › API i wysyłaj go z każdym żądaniem: Authorization: Bearer pxa_…. Token jest pokazywany raz, może wygasać i można go w każdej chwili unieważnić. Zakresy: pdash.read, pdash.write.

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

Listy, wersje i limity

Listy przychodzą stronami, od najnowszych. Każda zmiana zawiera odczytane expectedVersion i zwraca 409, jeśli rekord w międzyczasie się zmienił. Do 120 żądań na minutę na token; treść do 64 KB.

Endpointy

Opisy endpointów są po angielsku, tak jak dokument OpenAPI.

MetodaŚcieżkaZakresCo robi
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)

Webhooki

PaxHelm powiadamia Twój adres HTTPS, gdy coś się zmieni, z podpisem HMAC-SHA256 na każdym powiadomieniu i ponownymi próbami, gdy Twój serwer nie odpowiada. Zdarzenia:

  • 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