Listar oportunidades

View as Markdown
Lista as oportunidades acessíveis ao usuário autenticado. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. Sem limites de data, a consulta considera todo o período disponível. A referência do filtro de datas segue as preferências de relatório do usuário. Esta rota não recebe parâmetros de paginação. ### Parâmetros de consulta | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `states` | string | Não | Estados separados por vírgula: pending (em aberto), earned (ganha), lost (perdida). Padrão: os três estados. | | `start_date` | string | Não | Início do período, YYYY-MM-DD. | | `end_date` | string | Não | Fim do período, YYYY-MM-DD. | | `filed` | integer | Não | Filtro de arquivamento; padrão 0 (não arquivadas). | | `pipe` | integer | Não | ID do funil. | | `status` | string | Não | IDs de etapas separados por vírgula, por exemplo 10,20. | | `tag` | string | Não | Uma ou mais etiquetas separadas por vírgula. | | `responsible` | string | Não | IDs de responsáveis separados por vírgula. | ### 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` (cada elemento da lista): | Campo | Tipo | Descrição | |---|---|---| | `id` | integer | ID da oportunidade. | | `code` | string | Código comercial. | | `name` | string | Título. | | `client` | integer | ID do cliente. | | `company` | integer | ID da empresa emissora. | | `agent` | integer | ID do responsável. | | `pipe` | integer | ID do funil. | | `status` | integer | ID da etapa. | | `state` | string | pending, earned ou lost. | | `currency` | string | Moeda. | | `budget_value` | number | Valor comercial da proposta. | | `link` | string | Link de visualização, quando disponível. | | `create_date` | string | Data de criação. | | `expiration_date` | string | Validade. | ```json { "data": [ { "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" } ] } ``` 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
datalist of objects