Axuz Developers

GET /v1/templates/{id}

Detalhe de template (público, sem auth)

  • Access: Public
  • Service: https://api-forms.axuz.net

Accepted authentication

No authentication (public route, or protected by link/signature).

— GET /v1/templates/{id}. Detalhe do template.

Motivo: preview mostra Schema completo antes do user criar.

Comportamento: templates.Get por ID. 404 se não existe.

Entradas: path {id}.

Retorno: 200 Template, 404.

Parameters

NameInTypeRequiredDescription
idpathstringyes

Responses

200

Template

NameTypeRequiredDescription
idstringyes
slugstringyes
namestringyes
descriptionstringyes
categorystringyes

enum: "general", "marketing", "events", "support", "feedback", "hr"

iconstringyes

emoji simples.

layoutstringyes
schemaFormsFormSchemayes
schema.fieldsarray<FormsField>yes
schema.fields[].idstringyes
schema.fields[].typestringyes

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

schema.fields[].labelstringno
schema.fields[].namestringyes
schema.fields[].requiredbooleanno
schema.fields[].placeholderstringno
schema.fields[].help_textstringno
schema.fields[].defaultanyno
schema.fields[].optionsarray<FormsFieldOption>no
schema.fields[].options[].valuestringyes
schema.fields[].options[].labelstringyes
schema.fields[].max_lengthinteger | nullno
schema.fields[].minnumber | nullno
schema.fields[].maxnumber | nullno
schema.fields[].rowsinteger | nullno
schema.fields[].patternstringno
schema.fields[].extraobjectno
schema.stepsarray<FormsStep>no
schema.steps[].idstringyes
schema.steps[].titlestringyes
schema.steps[].field_idsarray<string>yes
schema.settingsFormsSettingsyes
schema.settings.submit_labelstringno
schema.settings.thank_you_messagestringno
schema.settings.redirect_urlstring | nullno
schema.settings.honeypotbooleanno

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

schema.settings.double_opt_inbooleanno
schema.settings.triggersarray<FormsTrigger>no
schema.settings.triggers[].idstringyes

client uuid

schema.settings.triggers[].typestringyes

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

schema.settings.triggers[].enabledbooleanyes
schema.settings.triggers[].labelstringno
schema.settings.triggers[].mappingobjectno
schema.settings.triggers[].configobjectno

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>>no

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

schema.settings.webhook_urlstringno
schema.settings.webhook_secretstringno

404

Recurso não encontrado

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NameTypeRequiredDescription
errorstringyes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X GET 'https://api-forms.axuz.net/v1/templates/ID'

Node.js

const res = await fetch("https://api-forms.axuz.net/v1/templates/ID", {
  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/v1/templates/ID",
    timeout=30,
)
res.raise_for_status()
print(res.json())