CVcvcrm
Motivos de Bloqueio de Distrato

Listar motivos de bloqueio de distrato

🔒 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)

Retorna listagem paginada de motivos de bloqueio de distrato ativos.

get/v3/comercial/motivos-bloqueio-distrato

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/v3/comercial/motivos-bloqueio-distrato
  • Auth
    HTTP bearer

Query parameters

paginainteger
Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger
Example:30

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

sortstring
Example:idusuario

Informa o campo a ser ordenado.

order'ASC' | 'DESC'

Informa a ordem da classificação.

search[operador|campo]string
Example:texto

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
    • isNull → campo não preenchido (o valor informado é ignorado)
    • isNotNull → campo preenchido (o valor informado é ignorado)

Response

Motivos retornados com sucesso.

statusstring required
codeinteger required

Example response

{
  "status": "sucesso",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 10,
    "totalRegistros": 42,
    "totalPaginas": 5
  },
  "filter": [
    {
      "campo": "nome",
      "valor": "Distrato"
    }
  ],
  "order": {
    "campo": "idmotivo",
    "valor": "ASC"
  },
  "data": [
    {
      "idmotivo": 1,
      "nome": "Distrato realizado pelo ERP",
      "ativoPainel": true,
      "descricaoObrigatoria": "N",
      "dataCad": "2025-01-15 10:00:00"
    }
  ]
}

Changes

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