Como listar boards e colunas do CRM via API

Antes de ler os cards (e contatos) de uma coluna, você precisa dos IDs do board e da coluna. Este tutorial mostra as duas formas mais comuns: copiar o ID na URL do app e consultar pela API REST.

Pré-requisito: token de integração.

Fluxo resumido

Token (Chaves de API)
  → listar boards  GET /crm/fetch
  → (ou) abrir o board no app e copiar o UUID da URL
  → listar colunas  GET /crm/columns/fetch?board_id=...
  → listar cards/contatos da coluna  GET /crm/cards/fetch?column_id=...

1. Obter o ID do board pela URL (mais rápido)

1. No app, abra o board desejado em CRM.
2. A URL fica assim:

https://app.whatswave.com.br/crm/<board_id>

Exemplo: https://app.whatswave.com.br/crm/9ccd4636-ee51-447f-b9fe-efd25f1be7cd
→ board_id = 9ccd4636-ee51-447f-b9fe-efd25f1be7cd

Guarde esse UUID — ele é o mesmo usado na API.

2. Listar todos os boards da empresa

curl -s "https://api.whatswave.com.br/crm/fetch" \
  -H "Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO"

Opcional: envie company_id explicitamente:

curl -s "https://api.whatswave.com.br/crm/fetch?company_id=SEU_COMPANY_ID" \
  -H "Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO"

Resposta (formato resumido):

{
  "success": true,
  "message": "Boards de CRM listados com sucesso",
  "data": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Board de Vendas",
      "description": "Pipeline comercial",
      "color": "#3B82F6",
      "company_id": "44444444-4444-4444-4444-444444444444",
      "enabled": true,
      "created_at": "2026-03-23T12:00:00.000Z",
      "updated_at": "2026-03-23T12:00:00.000Z"
    }
  ]
}

Use o campo data[].id como board_id nos próximos passos.

Detalhe de um board

curl -s "https://api.whatswave.com.br/crm/get?board_id=BOARD_ID" \
  -H "Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO"

GET /crm/get retorna os metadados do board (nome, cor, etc.). As colunas vêm no endpoint abaixo.

3. Listar as colunas do board

curl -s "https://api.whatswave.com.br/crm/columns/fetch?board_id=BOARD_ID" \
  -H "Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO"

Resposta (formato resumido):

{
  "success": true,
  "message": "Colunas listadas com sucesso",
  "data": [
    {
      "id": "22222222-2222-2222-2222-222222222222",
      "board_id": "11111111-1111-1111-1111-111111111111",
      "name": "Novo lead",
      "color": "#10B981",
      "position": 0,
      "enabled": true
    }
  ]
}

Cada data[].id é o column_id que você usa para buscar os cards daquela etapa do funil.

Headers e plano

Próximo passo

Com o column_id em mãos, leia os cards com os contatos vinculados (e paginação):

→ Como obter os contatos de uma coluna do CRM via API

Relacionados

• Como obter o token de integração
• API REST e GraphQL
• O que é o CRM
• Swagger: Documentação da API