v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar oportunidades

get/deals

Query parameters

showinteger

Número de itens na página de resultado

cursorstring

Hash da próxima página.

sortstring

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

withstring

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

hashstring

Hash da oportunidade

temperatureinteger

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

started_in_stage_idinteger

ID da etapa onde a oportunidade foi criada

statusinteger

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

deletedboolean

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

freezedboolean

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

lost_reason_idinteger

ID do motivo de perda da oportunidade

origin_idstring

ID da origem da oportunidade

owner_idinteger

ID do usuário dono da oportunidade

company_idinteger

ID da empresa vinculada à oportunidade

person_idinteger

ID da pessoa vinculada à oportunidade

pipeline_idinteger

ID do funil da oportunidade

stage_idinteger

ID da etapa da oportunidade

titlestring

Título da oportunidade

value_startnumber float

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

value_endnumber float

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

value_mrr_startnumber float

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

value_mrr_endnumber float

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

closed_at_startstring 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_endstring 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_startstring 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_endstring 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_startstring 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_endstring 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_startstring 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_endstring 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_startstring 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_endstring 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_startstring 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_endstring 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.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 748,
      "account_id": 748,
      "type_reference": 160,
      "reference": "f531d85c9b@emailtown.club",
      "temperature": 1,
      "probability": 100,
      "pipeline_id": 1,
      "owner_id": 1,
      "stage_id": 1,
      "person_id": 1,
      "company_id": 1,
      "lost_reason_id": 1,
      "origin_id": 1,
      "started_in_stage_id": 1,
      "city_id": 3826,
      "created_at": "2020-03-09",
      "title": "abc",
      "observation": "800 pessoas",
      "closed_at": "2020-03-16 22:27:42",
      "value": 100,
      "updated_at": "2020-04-09 16:51:50",
      "last_stage_updated_at": "2020-04-09 16:51:50",
      "value_mrr": 600,
      "probably_closed_at": "2020-02-28"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6MjU5....RlbXMiOnRydWV9"
    }
  }
}