Pular para o conteúdo
PaxHelm

A API do PaxHelm. Seus dados ao seu alcance.

Tarefas, projetos, notas, lembretes, acompanhamentos e pessoas do seu espaço, por HTTPS e em JSON, com as mesmas permissões que você tem no aplicativo. Nada é apagado pela API.

Documento OpenAPI 3.1Criar um token

Autenticação

Crie um token pessoal em Configurações › Segurança › API e envie-o em cada requisição: Authorization: Bearer pxa_…. O token aparece uma vez, pode ter validade e pode ser revogado a qualquer momento. Escopos: pdash.read, pdash.write.

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

Listas, versões e limites

As listas vêm em páginas, das mais recentes para as mais antigas. Cada alteração leva o expectedVersion lido e responde 409 se o registro mudou nesse meio-tempo. Até 120 requisições por minuto por token; corpos de até 64 KB.

Endpoints

As descrições dos endpoints estão em português de Portugal, como o documento OpenAPI.

MétodoEndereçoEscopoO que faz
GET/api/v1/taskspdash.readListar tarefas, das mais recentes para as mais antigas
POST/api/v1/taskspdash.writeCriar uma tarefa
GET/api/v1/tasks/{id}pdash.readObter uma tarefa
PATCH/api/v1/tasks/{id}pdash.writeAlterar uma tarefa (envie só os campos a mudar, com expectedVersion)
POST/api/v1/tasks/{id}/completepdash.writeConcluir uma tarefa
POST/api/v1/tasks/{id}/reopenpdash.writeReabrir uma tarefa
GET/api/v1/projectspdash.readListar projetos, das mais recentes para as mais antigas
POST/api/v1/projectspdash.writeCriar um projeto
GET/api/v1/projects/{id}pdash.readObter um projeto
PATCH/api/v1/projects/{id}pdash.writeAlterar um projeto (envie só os campos a mudar, com expectedVersion)
GET/api/v1/notespdash.readListar notas, das mais recentes para as mais antigas
POST/api/v1/notespdash.writeCriar uma nota
GET/api/v1/notes/{id}pdash.readObter uma nota
PATCH/api/v1/notes/{id}pdash.writeAlterar uma nota (envie só os campos a mudar, com expectedVersion)
GET/api/v1/reminderspdash.readListar lembretes, das mais recentes para as mais antigas
POST/api/v1/reminderspdash.writeCriar um lembrete
GET/api/v1/reminders/{id}pdash.readObter um lembrete
PATCH/api/v1/reminders/{id}pdash.writeAlterar um lembrete (envie só os campos a mudar, com expectedVersion)
POST/api/v1/reminders/{id}/completepdash.writeConcluir um lembrete
POST/api/v1/reminders/{id}/snoozepdash.writeAdiar um lembrete
GET/api/v1/follow-upspdash.readListar seguimentos, das mais recentes para as mais antigas
POST/api/v1/follow-upspdash.writeCriar um seguimento
GET/api/v1/follow-ups/{id}pdash.readObter um seguimento
PATCH/api/v1/follow-ups/{id}pdash.writeAlterar um seguimento (envie só os campos a mudar, com expectedVersion)
POST/api/v1/follow-ups/{id}/closepdash.writeFechar um seguimento
GET/api/v1/peoplepdash.readListar pessoas, das mais recentes para as mais antigas
POST/api/v1/peoplepdash.writeCriar uma pessoa
GET/api/v1/people/{id}pdash.readObter uma pessoa
PATCH/api/v1/people/{id}pdash.writeAlterar uma pessoa (envie só os campos a mudar, com expectedVersion)

Webhooks

O PaxHelm avisa um endereço HTTPS seu quando algo muda, com uma assinatura HMAC-SHA256 em cada aviso e novas tentativas quando seu servidor não responde. Eventos:

  • 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