Listar oportunidades

get

https://api.pipe.run/v1/deals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint utilizado para listar todas as oportunidades cadastradas na conta do CRM PipeRun.

Query Params

show

int32

Número de itens na página de resultado

cursor

string

Defaults to ""

Hash da próxima página.

sort

string

Critérios de ordenação (ASC / DESC)

with

string

Permite trazer objetos relacionados ao registro que possuem vinculo com o endpoint. items,persons,companies,users

hash

string

Hash da oportunidade

temperature

int32

Temperatura da oportunidade: (1= muito quente / 2= quente / 3= morna / 4= fria)

started_in_stage_id

int32

ID da etapa onde a oportunidade foi criada

status

int32

Filtrar pelo status da oportunidade (0= aberta / 1= ganha / 3= perdida)

deleted

boolean

Oportunidade na lixeira (False= fora da lixeira / True= na lixeira)

freezed

boolean

Oportunidade congelada (False= oportunidade não congelada / True= oportunidade congelada)

lost_reason_id

int32

ID do motivo de perda da oportunidade

origin_id

string

ID da origem da oportunidade

owner_id

int32

ID do usuário dono da oportunidade

company_id

int32

ID da empresa vinculada à oportunidade

person_id

int32

ID da pessoa vinculada à oportunidade

pipeline_id

int32

ID do funil da oportunidade

stage_id

int32

ID da etapa da oportunidade

title

string

Título da oportunidade

value_start

float

Valor de produtos e serviços (P&S) a partir do valor informado

value_end

float

Valor de produtos e serviços (P&S) vinculados até o valor informado

value_mrr_start

float

Valor de recorrência (MRR) a partir do valor informado

value_mrr_end

float

Valor de recorrência (MRR) até o valor informado

closed_at_start

date-time

Permite filtrar oportunidades considerando a data e hora em que foram fechadas, A PARTIR da data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

closed_at_end

date-time

Permite filtrar oportunidades considerando a data e hora em que foram fechadas, ANTERIORES à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

updated_at_start

date-time

Permite filtrar oportunidades considerando a data e hora em que foram atualizadas, A PARTIR à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

updated_at_end

date-time

Permite filtrar oportunidades considerando a data e hora em que foram atualizadas, ANTERIORES à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

created_at_start

date-time

Permite filtrar oportunidades considerando a data e hora em que foram criadas, A PARTIR à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

created_at_end

date-time

Permite filtrar oportunidades considerando a data e hora em que foram criadas, ANTERIORES à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

probably_closed_at_start

date

Permite filtrar oportunidades considerando a data de previsão de fechamento, A PARTIR à data informada. É possível informar data no formato AAAA-MM-DD

probably_closed_at_end

date

Permite filtrar oportunidades considerando a data de previsão de fechamento, ANTERIORES à data informada. É possível informar data no formato AAAA-MM-DD.

stage_movement_at_start

date-time

Permite filtrar oportunidades considerando a data e hora de movimentação, A PARTIR à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

stage_movement_at_end

date-time

Permite filtrar oportunidades considerando a data e hora de movimentação, ANTERIORES à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS)

last_contact_at_start

date-time

Permite filtrar oportunidades considerando a data e hora de último contato, A PARTIR à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS). São considerados como último contato: nota adicionada, atividade concluída, e-mail enviado e ligação realizada.

last_contact_at_end

date-time

Permite filtrar oportunidades considerando a data e hora de último contato, ANTERIORES à data informada. É possível informar data (DD-MM-AAAA ou AAAA-MM-DD) ou data e hora (DD-MM-AAAA HH:MM:SS ou AAAA-MM-DD HH:MM:SS). São considerados como último contato: nota adicionada, atividade concluída, e-mail enviado e ligação realizada.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404