GET
/
consultas
/
{id}
Buscar consulta por ID
curl --request GET \
  --url https://api.sollosconsultas.com.br/consultas/{id} \
  --header 'x-access-token: <api-key>'
{
  "id": 1,
  "name": "kyc_pf",
  "display_name": "KYC — Pessoa Física",
  "description": "Dados cadastrais, situação na Receita Federal e informações de contato.",
  "is_active": true,
  "parameters": [
    {
      "name": "cpf",
      "display_name": "CPF",
      "type": "string",
      "is_required": true
    }
  ]
}

​
Por que usar este endpoint

Antes de executar uma consulta, use este endpoint para descobrir:
  • Quais parâmetros ela aceita (parameters)
  • Quais deles são obrigatórios (is_required: true)
  • Se ela está ativa (is_active)
Os campos com is_required: true devem estar presentes no body de POST /consultas/executar/{id}. Campos opcionais (is_required: false) podem ser omitidos — a consulta ainda funciona com valores padrão.

Authorizations

​
x-access-token
string
header
required

Token JWT retornado pelo endpoint POST /auth/login. Inclua este header em todas as requisições autenticadas.

Path Parameters

​
id
integer
required

ID da consulta

Response

Detalhes da consulta com seus parâmetros configurados.

​
id
integer
Example:

1

​
name
string
Example:

"kyc_pf"

​
display_name
string
Example:

"KYC — Pessoa Física"

​
description
string
Example:

"Dados cadastrais, situação na Receita Federal e informações de contato."

​
is_active
boolean
Example:

true

​
parameters
object[]

Parâmetros aceitos por esta consulta. Os campos com is_required: true são obrigatórios no body de execução.