Endpoint

POST /getFormCatalogs

Parâmetros

hostId
string (UUID)

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

domainId
string (UUID)

Valida que o host pertence ao domain informado.

avatarId
string (UUID)

Filtra catálogos vinculados ao avatar especificado.

Exemplo

curl -X POST {BASE_URL}/getFormCatalogs \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "avatarId": "uuid-opcional"
  }'

Resposta

[
  {
    "id": "uuid",
    "name": "Formulário de Contato",
    "is_active": true,
    "instructions": "Preencha todos os campos obrigatórios",
    "unique": "Formulário de Contato",
    "forms": [
      {
        "id": "uuid",
        "name": "Formulário de Contato",
        "description": "Formulário para captura de dados de contato",
        "general_instructions": "Preencha todos os campos obrigatórios",
        "created_at": "2024-01-15T10:30:00Z",
        "total_fields": 5,
        "total_decision_chains": 2,
        "scope": "leads"
      }
    ]
  }
]

A resposta é sempre um array (retorna [] se não houver catálogos). Em erro, o retorno é um objeto com error. Valide antes de usar .map() ou .reduce():

const data = await response.json();
const catalogs = Array.isArray(data) ? data : [];

Campos da Resposta

id
string
UUID do catálogo.
name
string
Nome do catálogo.
is_active
boolean
Se o catálogo está ativo.
instructions
string
Instruções gerais do catálogo.
forms
array

Erros

CódigoDescrição
401Token inválido ou ausente
400Parâmetros inválidos
500Erro interno do servidor