Listar

Método: GET


Parâmetros da requisição (Query params):
page = Page

limit = LimitResult

order = Order

direction = asc | desc

name = NomeDaOportunidade

exact_name =  true | false

win = true | false | null

user_id = IdUsuario

start_date = DATA (yyyy-mm-ddT15:00:00-03:00)

end_date = DATA (yyyy-mm-ddT15:00:00-03:00)

closed_at = bool

closed_at_period = bool

created_at_period = bool

prediction_date_period = bool

closed_by_id = UserID

deal_stage_id = IdDaEtapa

deal_lost_reason_id = IdMotivoDePerda

organization = IdEmpresa

hold = bool

product_presence = true | false | ids

Nome/ObsTipoDescriçãoObrigatórioObservação
tokenURLToken para autenticaçãoN.T
pageURLPágina da listagemValor padrão é 1
limitURLLimite de oportunidades por páginaValor padrão é 20. Valor máximo é 200
orderURLCampo a ser ordenadoValor padrão é "created_at"
directionURLOrdenação da lista"asc" ou "desc", padrão é "desc"
nameURLNome da oportunidadePara buscas com nome exato, usar o parâmetro exact_name= true
winURLOportunidades ganhasCom o valor true para trazer as oportunidades ganhas, false para trazer as oportunidades perdidas e null para retornar as oportunidades em aberto
user_idURLID do usuário relacionado à oportunidadeN.T
closed_atURLAo informar true, retorna as oportunidades GANHAS/PERDIDAS. Ao informar false, retorna as oportunidades EM ABERTO OU PAUSADASN.T
closed_at_periodURLData de fechamento da deal: se true deve ser informado start_date e end_dateN.T
created_at_periodURLData de criação da deal: se true, deve ser informado start_date e end_dateN.T
prediction_date_periodURLData de previsão de fechamento da oportunidade: se true, deve ser informado start_date e end_dateN.T
start_dateURLPrimeiro dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_periodEx.: "start_date": "2020-12-14T15:00:00-03:00
end_dateURLÚltimo dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_periodEx.: "end_date": "2020-12-14T15:00:00-03:00
campaign_idURLID da campanhaN.T
deal_stage_idURLID da etapaN.T
deal_lost_reason_idURLID do motivo de perdaN.T
organizationURLID da empresaN.T
holdURLEstado da oportunidade pausadaSe marcado como true, retorna todas oportunidades pausadas. Para outros casos, não deve-se utilizar esse parâmetro
product_presenceURLOportunidades que contenham produtos/serviços relacionados: false (nenhum produto relacionado), true (um ou mais produtos relacionados) ou uma lista de IDs de produtoA lista de IDs deve ser informada com os valores separados por vírgula. Ex.: 5esdsds, d767dsdssd, c6e40fd2f000972a083