CVcvcrm
Executar Query

POST /v4/integrar/executa-query

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

Executa uma consulta SELECT a partir de uma AST (Abstract Syntax Tree) em JSON. O backend valida que a AST representa apenas SELECT e a converte em SQL com prepared statements, bloqueando qualquer operação DML (INSERT, UPDATE, DELETE, DROP, etc.). Quando 'limit' não é informado, aplica-se o limite padrão de 50 registros (teto máximo de 500). A especificação completa dos nós está em app/src/Vender/Query/Application/Services/AST_GUIDE.md. Requer autenticação JWT (painel gestor).

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/v4/integrar/executa-query
  • Auth
    HTTP bearer

Request body

paramsobject

Parâmetros nomeados adicionais mesclados aos placeholders gerados pela AST.

Example request

{
  "ast": {
    "type": "select",
    "columns": [
      {
        "expression": {
          "type": "function",
          "name": "COUNT",
          "args": [
            {
              "type": "column_ref",
              "column": "*"
            }
          ]
        },
        "alias": "total"
      }
    ],
    "from": {
      "type": "table",
      "table": "leads"
    },
    "where": {
      "type": "binary_expression",
      "operator": "=",
      "left": {
        "type": "column_ref",
        "column": "status"
      },
      "right": {
        "type": "string",
        "value": "ativo"
      }
    },
    "limit": 50
  }
}

Response

Retorna os dados da query

statusstring
codeinteger
dataobject[]

Example response

{
  "status": "success",
  "code": 200,
  "data": [
    {
      "total": 128
    }
  ]
}

Changes

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