Históricos

Pesquisar

get/history

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/history
  • 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,description
filter[id]integer

Código do histórico.

Example:1
filter[history_type_id]integer

ID do Tipo do Histórico.

Example:1
filter[module_type]string

Módulo que gerou o histórico.

Example:deal
filter[module_id]integer

ID do registro do módulo.

Example:123
filter[date]string

date Data do Evento.

Example:2024-01-01
filter[user_id]integer

Responsável pelo histórico.

Example:321
filter[person_id]integer

Código do cliente da Imobiliária vinculado ao módulo.

Example:1111
filter[description]string

Descrição.

Example:Tentei contato com o cliente, mas não houve retorno
filter[child_type]integer

Módulo Filho.

filter[child_id]integer

ID do registro do módulo filho.

Example:1233
filter[parent_id]integer

Código do histórico pai, utilizado para resposta de comentários por exemplo.

Example:321
filter[private]boolean

Histórico privado.

filter[visualized_by]string

json[] Usuários que visualizaram o histórico.

Example:[{"user":1233,"dateTime":"2024-10-14T13:38:52.089117Z"}]
filter[mentions]integer[]

Código dos usuários mencionados.

[
  123,
  3131
]
filter[fixed]boolean

Histórico fixado.

include[module]string

Retorna os dados do registro que gerou o histórico.

Example:id,title
include[child]string

Retorna os dados do registro filho que gerou o histórico.

Example:id,title
include[replies]string

Retorna as respostas vinculadas ao histórico pai.

Example:id,description
include[parent]string

Retorna os dados do histórico pai.

Example:id,description
include[user]string

Retorna o usuário que gerou o histórico.

Example:id,name,email
include[person]string

Retorna a pessoa/cliente que está vinculada ao histórico.

Example:id,name
include[type]string

Retorna o tipo de histórico.

Example:id,description
include[mentionedUsers]string

Retorna os usuários mencionados.

Example:id,name,email

Changes

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