Перейти до вмісту
PaxHelm

API PaxHelm. Ваші дані під рукою.

Завдання, проєкти, нотатки, нагадування, контроль відповідей і люди вашого простору через 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 КБ.

Ендпоінти

Описи ендпоінтів — англійською, як і документ 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)

Вебхуки

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