OmieapiDocumentaçãoOperações
← Referência das operações

ListarOportunidadesconsulta

Lista de oportunidades.

Identificação

Operaçãocrm/oportunidades:ListarOportunidades
Serviçooportunidades
MóduloCRM
Endpoint/api/v1/crm/oportunidades/

Como as pessoas pedem isso

listar oportunidades crm

Parâmetros

CampoTipoDescrição
ano_previsao_finalstringAno de previsão final da oportunidade.
ano_previsao_inicialstringAno de previsão inicial da oportunidade.
apenas_importado_apistringExibir apenas os registros gerados pela API
codigo_vendedorintegerCódigo do Vendedor.
data_alteracao_finalstringData de alteração final
data_alteracao_inicialstringData de alteração inicial.
data_inclusao_finalstringData de inclusão final da oportunidade.
data_inclusao_inicialstringData de inclusão inicial da oportunidade.
email_vendedorstringE-Mail do Vendedor
exibir_apenas_op_vendedorstringExibir apenas as oportunidades que pertencem ao vendedor selecionado. Ativando esse filtro os vendedores com credenciais para visualizar todas as oportunidades passam a se comportam como um usuário comum, que tem acesso apenas as suas próprias oportunidades.
exibir_detalhesstringExibe os detalhes da oportunidade.
exibir_obsstringExibir as observações da oportunidade (S/N). Preenchimento Opcional. Preencher com "S" ou "N".
faseintegerCódigo da fase da oportunidade.
filtrar_por_containtegerCódigo da conta. (Gerado internamente, não é visualizado na tela)
filtrar_por_descricaostringDescrição da oportunidade.
hora_alteracao_finalstringHora de alteração final.
hora_alteracao_inicialstringHora de alteração inicial
hora_inclusao_finalstringHora de inclusão final.
hora_inclusao_inicialstringHora de inclusão inicial.
mes_previsao_finalstringMês de previsão final da oportunidade.
mes_previsao_inicialstringMês de previsão inicial da oportunidade.
motivointegerCódigo do motivo.
ordem_decrescentestringSe a lista será apresentada em ordem decrescente.
ordenar_porstringOrdem de exibição dos dados. Padrão: Código.
paginaintegerNúmero da página para resgatar os dados.
registros_por_paginaintegerNúmero de registros a serem exibidos por página. Máximo 50.
statusstringStatus da oportunidade. Pode ser: A - Ativo C - Cancelado P - Perdido S - Suspenso V - Conquistado Para informar mais de um status utilize virgulas.

Exemplo de chamada

{
  "pagina": 1,
  "registros_por_pagina": 20
}
api.omie.com.br/mcp · Documentação · Operações