Boards (Processos e Membros)

Endpoints para gerenciar quadros, fases, permissões e membros de equipe no Perpetuus CRM.

Os Boards (ou quadros) definem os processos de negócio da organização (ex: Funil de Vendas, Suporte ao Cliente). Cada board contém fases (colunas), tags e campos dinâmicos customizados.

Endpoints Principais

Para ver a especificação completa de cada endpoint com todas as opções de parâmetros e respostas, acesse a API Reference.

1. Listar Boards

Retorna os quadros ativos da organização. Operadores veem apenas os quadros dos quais são membros.

Método: GET
Caminho: /boards

Exemplo de Chamada:

curl "https://api.perpetuus.com.br/api/boards" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "x-tenant-id: acme"

2. Criar Board

Cria um novo quadro de processo. É possível criar a partir de um template pré-configurado usando o parâmetro template (ex: minimal-workflow).

Método: POST
Caminho: /boards

Payload de Exemplo:

{
  "data": {
    "name": "Suporte Nível 1",
    "boardType": "kanban",
    "color": "#10B981",
    "template": "minimal-workflow"
  }
}

3. Buscar Detalhes de um Board

Retorna a árvore completa do quadro, incluindo suas Fases (colunas), Tags configuradas e Campos Dinâmicos.

Método: GET
Caminho: /boards/{id}

Dica de Leitura: Use este endpoint no início do seu fluxo de integração para mapear os documentId das fases e os slugs de campos customizados que você precisará usar ao enviar novos cards.

Gestão de Membros e Editores do Board

Os quadros possuem controle granular sobre quem pode ver e alterar os cards.

Listar Membros do Board

Retorna a lista de colaboradores (memberships) que possuem acesso de leitura ou escrita no quadro.

Método: GET
Caminho: /boards/{id}/members

Adicionar Membro

Método: POST
Caminho: /boards/{id}/members

Payload:

{
  "data": {
    "membershipId": "membership_doc_id_99"
  }
}

Remover Membro

Método: DELETE
Caminho: /boards/{id}/members/{membershipId}

On this page