Перейти к содержимому
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