Detalhar funil | WBudget

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

Campo	Tipo	Obrigatório	Descrição
`id`	integer	Sim	ID 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:

Campo	Tipo	Descrição
`id`	integer	ID do funil.
`name`	string	Nome do funil.
`order`	integer	Ordem de exibição.
`init_status`	integer	ID da etapa inicial.
`status_count`	integer	Quantidade de etapas.
`statuses`	array<object>	Etapas ordenadas.
`statuses[].id`	integer	ID da etapa.
`statuses[].name`	string	Nome da etapa.
`statuses[].color`	string	Cor de exibição.
`statuses[].order`	integer	Ordem da etapa.

{
  "data": {
    "id": 1,
    "name": "Vendas",
    "order": 1,
    "statuses": [
      {
        "id": 10,
        "name": "Em negociação",
        "color": "#3498db",
        "order": 1
      }
    ]
  }
}

Erros específicos

HTTP	Código	Situação
404	`PIPE_NOT_FOUND`	Pipe not found.

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

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 | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | integer | Sim | ID 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`: | Campo | Tipo | Descrição | |---|---|---| | `id` | integer | ID do funil. | | `name` | string | Nome do funil. | | `order` | integer | Ordem de exibição. | | `init_status` | integer | ID da etapa inicial. | | `status_count` | integer | Quantidade de etapas. | | `statuses` | array<object> | Etapas ordenadas. | | `statuses[].id` | integer | ID da etapa. | | `statuses[].name` | string | Nome da etapa. | | `statuses[].color` | string | Cor de exibição. | | `statuses[].order` | integer | Ordem da etapa. | ```json { "data": { "id": 1, "name": "Vendas", "order": 1, "statuses": [ { "id": 10, "name": "Em negociação", "color": "#3498db", "order": 1 } ] } } ``` ### Erros específicos | HTTP | Código | Situação | |---|---|---| | 404 | `PIPE_NOT_FOUND` | Pipe 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

dataobject

Errors

404

Not Found Error