Carregar kanban do funil
Consulta o quadro de oportunidades organizado por etapas.
**Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.
Se pipe for omitido ou não estiver disponível ao usuário, será usado o primeiro funil acessível. Cada coluna contém a etapa, as oportunidades e a soma de seus valores.
### Parâmetros de consulta
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `pipe` | integer | Não | ID do funil desejado. |
### Resposta
HTTP **200**. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.
Campos principais de `data`:
| Campo | Tipo | Descrição |
|---|---|---|
| `pipes` | array<object> | Funis disponíveis. |
| `pipe` | object | Funil selecionado. |
| `columns` | array<object> | Colunas do quadro. |
| `columns[].status` | object | Etapa da coluna. |
| `columns[].cards` | array<object> | Oportunidades da etapa. |
| `columns[].total` | number | Soma dos valores das oportunidades da coluna. |
```json
{
"data": {
"pipes": [
{
"id": 1,
"name": "Vendas",
"order": 1,
"statuses": [
{
"id": 10,
"name": "Em negociação",
"color": "#3498db",
"order": 1
}
]
}
],
"pipe": {
"id": 1,
"name": "Vendas",
"order": 1,
"statuses": [
{
"id": 10,
"name": "Em negociação",
"color": "#3498db",
"order": 1
}
]
},
"columns": [
{
"status": {
"id": 10,
"name": "Em negociação",
"color": "#3498db",
"order": 1
},
"cards": [
{
"id": 1001,
"code": "PROP-2026-001",
"name": "Proposta de serviços",
"client": 101,
"client_name": "Empresa Exemplo",
"company": 1,
"status": 10,
"pipe": 1,
"state": "pending",
"currency": "BRL",
"budget_value": 1500,
"create_date": "2026-09-01T10:00:00-03:00",
"expiration_date": "2026-09-30T00:00:00-03:00"
}
],
"total": 1500
}
]
}
}
```
### Erros específicos
| HTTP | Código | Situação |
|---|---|---|
| 404 | `PIPE_NOT_FOUND` | No pipe available. |
Consulte a introdução da collection para o formato de erros e a configuração das variáveis.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
OK
data
Errors
404
Not Found Error
