Negócios

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Negócios</aside>
get/deals

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/deals
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,name,phone,email
filter[title]string

Título.

Example:Título do Negócio.
filter[step_id]integer

Etapa do Negócio.

Example:1
filter[step_date]string

date Data da Etapa do Negócio.

Example:2022-08-31 00:00:00
filter[status]string

Status do Negócio.

Example:won
filter[status_date]string

date Date do Status do Negócio.

Example:2022-12-06 10:17:16
filter[type]string

Tipo do Negócio (Radar).

Example:sale
filter[responsible]integer[]

Responsável(s) pelo Negócio.

[
  123,
  456,
  789
]
filter[customer_id]integer

Cliente do Negócio.

Example:1234
filter[origin_id]integer

Origem do Negócio.

Example:9
filter[price]string

Valor do Negócio.

Example:1500.00
filter[date]string

date Data do Negócio.

Example:2020-04-30
filter[forecast]string

date Data da previsão de finalização do Negócio.

Example:2020-05-30
filter[potential]string

Potencial do Negócio. Options: cold, hot, scalding, warm.

Example:hot
filter[radar]boolean

Radar Ativo para o Negócio.

Example:true
filter[private]boolean

Visibilidade do Negócio.

Example:true
filter[position]integer

Posição do negócio (Kanban).

Example:3
filter[tag]integer[]

Tags para o Negócio.

[
  1326,
  1306,
  1305
]
filter[building]integer[]

Imóveis para o Negócio.

[
  13914,
  15155,
  15467
]
filter[extend]string

date Prorrogação do Negócio.

Example:2022-02-21
filter[reason_id]integer

Motivo do Negócio quando o status é alterado.

Example:1
filter[reason_notes]string

Observações do motivo quando o status do Negócio é alterado.

Example:Cliente ganho
filter[building_type]integer[]

Tipos de Imóveis para o Radar de Negócio.

[
  5,
  1,
  3
]
filter[building_stage]integer[]

Estágio dos Imóveis para o Radar de Negócio.

[
  3
]
filter[building_furnishing]string[]

Mobília dos Imóveis para o Radar de Negócio.

filter[building_price_min]string

Valor mínimo dos Imóveis do Negócio (Radar).

Example:1500.00
filter[building_price_max]string

Valor máximo dos Imóveis do Negócio (Radar).

Example:2500.00
filter[building_bedroom]integer

Quantidade de quartos para o Radar de Negócio.

Example:2
filter[building_living_room]integer

Quantidade de salas para o Radar de Negócio.

Example:1
filter[building_parking]integer

Quantidade de vagas de estacionamento para o Radar de Negócio.

Example:1
filter[building_bathroom]integer

Quantidade de banheiros para o Radar de Negócio.

Example:3
filter[building_area]integer

Área em metros quadrados para o Radar de Negócio.

Example:120
filter[building_district]string

Bairro para o Radar de Negócio.

Example:1
filter[building_city]string

Cidade para o Radar de Negócio.

Example:3
filter[building_detail]integer[]

Detalhes do Imóvel para o Radar de Negócio.

[
  9889,
  29988
]
filter[building_check_in]string

date Check-in do Imóvel para o Radar de Negócio.

Example:2022-02-21
filter[building_check_out]string

date Check-out do Imóvel para o Radar de Negócio.

Example:2022-02-21
filter[building_accommodation]integer

Quantidade de acomodações do Imóvel para o Radar de Negócio.

Example:4
include[tags]string

Retorna as tags do negócio

Example:reiciendis
include[notifications]string

Retorna as notificações do negócio

Example:quos
include[contracts]string

Retorna os contratos vinculados ao negócio

Example:minima
include[buildings]string

Retorna os imóveis vinculados ao negócio

Example:quasi
include[responsibles]string

Retorna os responsáveis do negócio

Example:facere
include[creator]string

Retorna o criador do negócio

Example:eos
include[customer]string

Retorna o cliente do negócio

Example:cumque
include[proposals]string

Retorna as propostas do negócio

Example:dolores
include[activeProposals]string

Retorna as propostas (pendentes ou aceitas) do negócio.

Example:sint
include[leads]string

Retorna os leads do negócio

Example:ipsum
include[reason]string

Retorna o motivo do status do negócio.

Example:id,notes
include[step]string

Retorna a etapa do negócio.

Example:id,description
include[files]string

Retorna os arquivos do negócio.

Example:id,file_name
include[origin]string

Retorna a origem do negócio.

Example:id,name
include[lastHistory]string

Retorna o último histórico da negociação.

Example:id,created_at
include[districts]string

Retorna os bairros dos imóveis (Radar).

Example:id,name
include[cities]string

Retorna as cidades dos imóveis (Radar).

Example:id,name
include[details]string

Retorna os detalhes dos imóveis (Radar).

Example:id
include[buildingTypes]string

Retorna os tipos dos imóveis (Radar).

Example:id,name
include[buildingStages]string

Retorna os estágios dos imóveis (Radar).

Example:id,name
include[eventsNotConcludedNonRecurring]string

Retorna eventos não recorrentes que não estão concluídos.

Example:id,type,title

Changes

No recorded changes to this operation across all 1 revision of this API.