Axuz Developers

GET /public/forms/{slug}

Retorna schema JSON de um form publicado

  • Acesso: Pública
  • Serviço: https://api-forms.axuz.net

Autenticação aceita

Sem autenticação (rota pública ou protegida por link/assinatura).

Consumido por SDKs custom (React embed, plugin WordPress, apps mobile) que renderizam nativo em vez de HTML server-side. Só forms com status=published e deleted_at IS NULL. Sem credentials — Access-Control-Allow-Origin: *.

Parâmetros

NomeEmTipoObrigatórioDescrição
slugpathstringsim

Slug URL-safe do form (^[a-zA-Z0-9_-]{3,64}$).

Respostas

200

Schema do form

NomeTipoObrigatórioDescrição
idstring<uuid>sim
slugstringsim
namestringsim
descriptionstring | nullnão
layoutstringsim
schemaFormsFormSchemasim
schema.fieldsarray<FormsField>sim
schema.fields[].idstringsim
schema.fields[].typestringsim

enum: "text", "email", "phone", "textarea", "number", "select", "radio", "checkbox", "date", "url", "file", "hidden"

schema.fields[].labelstringnão
schema.fields[].namestringsim
schema.fields[].requiredbooleannão
schema.fields[].placeholderstringnão
schema.fields[].help_textstringnão
schema.fields[].defaultanynão
schema.fields[].optionsarray<FormsFieldOption>não
schema.fields[].options[].valuestringsim
schema.fields[].options[].labelstringsim
schema.fields[].max_lengthinteger | nullnão
schema.fields[].minnumber | nullnão
schema.fields[].maxnumber | nullnão
schema.fields[].rowsinteger | nullnão
schema.fields[].patternstringnão
schema.fields[].extraobjectnão
schema.stepsarray<FormsStep>não
schema.steps[].idstringsim
schema.steps[].titlestringsim
schema.steps[].field_idsarray<string>sim
schema.settingsFormsSettingssim
schema.settings.submit_labelstringnão
schema.settings.thank_you_messagestringnão
schema.settings.redirect_urlstring | nullnão
schema.settings.honeypotbooleannão

Se true, adiciona campo axuz_hp e rejeita submits com valor.

schema.settings.double_opt_inbooleannão
schema.settings.triggersarray<FormsTrigger>não
schema.settings.triggers[].idstringsim

client uuid

schema.settings.triggers[].typestringsim

enum: "email", "webhook", "calendar_event", "workspace_task"

schema.settings.triggers[].enabledbooleansim
schema.settings.triggers[].labelstringnão
schema.settings.triggers[].mappingobjectnão
schema.settings.triggers[].configobjectnão

Shape depende de type: - email: { to: string[] } - webhook: { url: string, secret?: string } - calendar_event/workspace_task: fields específicos do módulo.

schema.settings.notify_emailsarray<string<email>>não

Legacy Fase 178. Promovido em memória pra Triggers no read.

schema.settings.webhook_urlstringnão
schema.settings.webhook_secretstringnão

404

Recurso não encontrado

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro inesperado

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://api-forms.axuz.net/public/forms/SLUG'

Node.js

const res = await fetch("https://api-forms.axuz.net/public/forms/SLUG", {
  method: 'GET',
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://api-forms.axuz.net/public/forms/SLUG",
    timeout=30,
)
res.raise_for_status()
print(res.json())