Skip to navigation

Listar oportunidades

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

CampoTipoObrigatórioDescrição
statesstringNãoEstados separados por vírgula: pending (em aberto), earned (ganha), lost (perdida). Padrão: os três estados.
start_datestringNãoInício do período, YYYY-MM-DD.
end_datestringNãoFim do período, YYYY-MM-DD.
filedintegerNãoFiltro de arquivamento; padrão 0 (não arquivadas).
pipeintegerNãoID do funil.
statusstringNãoIDs de etapas separados por vírgula, por exemplo 10,20.
tagstringNãoUma ou mais etiquetas separadas por vírgula.
responsiblestringNãoIDs 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):

CampoTipoDescrição
idintegerID da oportunidade.
codestringCódigo comercial.
namestringTítulo.
clientintegerID do cliente.
companyintegerID da empresa emissora.
agentintegerID do responsável.
pipeintegerID do funil.
statusintegerID da etapa.
statestringpending, earned ou lost.
currencystringMoeda.
budget_valuenumberValor comercial da proposta.
linkstringLink de visualização, quando disponível.
create_datestringData de criação.
expiration_datestringValidade.
{
"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.

Query parameters

statesstringOptional

string. Estados separados por vírgula: pending (em aberto), earned (ganha), lost (perdida). Padrão: os três estados.

start_datestringOptional

string. Início do período, YYYY-MM-DD.

end_datestringOptional

string. Fim do período, YYYY-MM-DD.

filedstringOptional

integer. Filtro de arquivamento; padrão 0 (não arquivadas).

pipestringOptional
integer. ID do funil.
statusstringOptional

string. IDs de etapas separados por vírgula, por exemplo 10,20.

tagstringOptional

string. Uma ou mais etiquetas separadas por vírgula.

responsiblestringOptional

string. IDs de responsáveis separados por vírgula.

Response

200 — Sucesso — exemplo ilustrativo

datalist of objectsOptional