v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Mensagens da comissão

Retorna as mensagens de uma comissão

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Api responsável por retornar as mensagens de uma comissão

get/v3/financeiro/comissoes/{idComissao}/mensagens

Path parameters

idComissaointeger required

Example:7367

Identificador da comissão.

Query parameters

registros_por_paginainteger

Example:30

Quantidade de registro por página, máximo 500 registros.

paginainteger

Example:1

Página que deseja visualizar os registros.

sortstring

Example:idusuario

Informa o campo a ser ordenado.

order'ASC' | 'DESC'

Informa a ordem da classificação.

search[operador|campo]string

Example:14

Informa o termo para busca.

Operadores suportados:
- equal → igual
- notEqual → diferente
- greaterThan → maior que
- greaterThanOrEqual → maior ou igual a
- lessThan → menor que
- lessThanOrEqual → menor ou igual a
- in → dentro de lista de valores (passar valores separados por vírgula)
- notIn → fora de lista de valores (passar valores separados por vírgula)
- like → contém o valor informado

Response

Mensagens da comissão retornadas com sucesso.

statusstring required

Situação da requisição

codeinteger required

Código da requisição

Example response

{
  "status": "success",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 3,
    "totalRegistros": 3,
    "totalPaginas": 1
  },
  "filter": [
    {
      "campo": "idusuario",
      "valor": "14"
    }
  ],
  "order": {
    "campo": "idusuario",
    "valor": "ASC"
  },
  "data": [
    {
      "idmensagem": 123,
      "idcomissao": 2,
      "dataCad": "2022-03-28 20:35:57",
      "mensagem": "Comentário de teste",
      "idusuario": 1,
      "idusuarioImobiliaria": 1,
      "idcorretor": 1,
      "audioNome": "teste.mp3",
      "audioTranscricao": "Teste de áudio"
    }
  ]
}