Listar

URL: https://plugcrm.net/api/v1/deals?token=MY_TOKEN&Parametros

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/Obs	Tipo	Descrição	Obrigatório	Observação
token	URL	Token para autenticação	✓	N.T
page	URL	Página da listagem	✘	Valor padrão é 1
limit	URL	Limite de oportunidades por página	✘	Valor padrão é 20. Valor máximo é 200
order	URL	Campo a ser ordenado	✘	Valor padrão é "created_at"
direction	URL	Ordenação da lista	✘	"asc" ou "desc", padrão é "desc"
name	URL	Nome da oportunidade	✘	Para buscas com nome exato, usar o parâmetro exact_name= true
win	URL	Oportunidades ganhas	✘	Com o valor true para trazer as oportunidades ganhas, false para trazer as oportunidades perdidas e null para retornar as oportunidades em aberto
user_id	URL	ID do usuário relacionado à oportunidade	✘	N.T
closed_at	URL	Ao informar true, retorna as oportunidades GANHAS/PERDIDAS. Ao informar false, retorna as oportunidades EM ABERTO OU PAUSADAS	✘	N.T
closed_at_period	URL	Data de fechamento da deal: se true deve ser informado start_date e end_date	✘	N.T
created_at_period	URL	Data de criação da deal: se true, deve ser informado start_date e end_date	✘	N.T
prediction_date_period	URL	Data de previsão de fechamento da oportunidade: se true, deve ser informado start_date e end_date	✘	N.T
start_date	URL	Primeiro dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period	✘	Ex.: "start_date": "2020-12-14T15:00:00-03:00
end_date	URL	Último dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period	✘	Ex.: "end_date": "2020-12-14T15:00:00-03:00
campaign_id	URL	ID da campanha	✘	N.T
deal_stage_id	URL	ID da etapa	✘	N.T
deal_lost_reason_id	URL	ID do motivo de perda	✘	N.T
organization	URL	ID da empresa	✘	N.T
hold	URL	Estado da oportunidade pausada	✘	Se marcado como true, retorna todas oportunidades pausadas. Para outros casos, não deve-se utilizar esse parâmetro
product_presence	URL	Oportunidades que contenham produtos/serviços relacionados: false (nenhum produto relacionado), true (um ou mais produtos relacionados) ou uma lista de IDs de produto	✘	A lista de IDs deve ser informada com os valores separados por vírgula. Ex.: 5esdsds, d767dsdssd, c6e40fd2f000972a083