Skip to navigation

Detalhar funil

Consulta um funil e suas etapas.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID do funil.

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:

CampoTipoDescrição
idintegerID do funil.
namestringNome do funil.
orderintegerOrdem de exibição.
init_statusintegerID da etapa inicial.
status_countintegerQuantidade de etapas.
statusesarray<object>Etapas ordenadas.
statuses[].idintegerID da etapa.
statuses[].namestringNome da etapa.
statuses[].colorstringCor de exibição.
statuses[].orderintegerOrdem da etapa.
{
"data": {
"id": 1,
"name": "Vendas",
"order": 1,
"statuses": [
{
"id": 10,
"name": "Em negociação",
"color": "#3498db",
"order": 1
}
]
}
}

Erros específicos

HTTPCódigoSituação
404PIPE_NOT_FOUNDPipe not found.

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.

Path parameters

idstringRequired
ID do funil.

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

404
Not Found Error