Endpoint

POST /getCatalogSchema

Parâmetros

catalogId
string (UUID)
required

ID do formulário a ser consultado.

hostId
string (UUID)

ID do host. Se omitido, é derivado do token.

Exemplo

curl -X POST {BASE_URL}/getCatalogSchema \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "catalogId": "uuid-do-formulario"
  }'

Resposta

{
  "catalogId": "uuid",
  "name": "Formulário de Contato",
  "description": "Formulário para capturar dados de contato",
  "scope": "lead",
  "generalInstructions": "Preencha todos os campos obrigatórios",
  "totalFields": 3,
  "schema": {
    "name": "form_uuid",
    "description": "Captura estruturada do formulário...",
    "parameters": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "nome_cliente": {
          "type": "string",
          "description": "Nome do Cliente"
        },
        "email_cliente": {
          "type": "string",
          "format": "email",
          "description": "Email do Cliente Campo obrigatório."
        }
      },
      "required": ["email_cliente"]
    }
  },
  "fields": [
    {
      "variableId": "uuid",
      "keyName": "nome_cliente",
      "propertyKey": "nome_cliente",
      "label": "Nome do Cliente",
      "description": "",
      "dataType": "text",
      "required": false,
      "captureStrategy": "overwrite",
      "orderIndex": 0
    }
  ]
}

Campos da Resposta

catalogId
string
UUID do formulário.
name
string
Nome do formulário.
scope
string
Escopo: lead, conversation, global ou form.
totalFields
number
Total de campos no formulário.
schema
object
fields
array

Erros

CódigoDescrição
400catalogId ausente ou inválido
401Token inválido ou ausente
404Formulário não encontrado para o host
500Erro interno do servidor