GET /v1/templates/
Lista templates (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. Lista o catálogo (filtro por category).
Motivo: página "Novo formulário" no forms_client mostra grid de templates com preview. Filtro por categoria (general/marketing/ events/support/feedback/hr) reduz cognitive load.
Comportamento: templates.All → filtro category opcional → 200 {items}.
Entradas: query category?.
Retorno: 200 {items}.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
category | query | string | no |
Responses
200
Catálogo
| Name | Type | Required | Description |
|---|---|---|---|
items | array<FormsTemplate> | yes | |
items[].id | string | yes | |
items[].slug | string | yes | |
items[].name | string | yes | |
items[].description | string | yes | |
items[].category | string | yes | enum: |
items[].icon | string | yes | emoji simples. |
items[].layout | string | yes | |
items[].schema | FormsFormSchema | yes | |
items[].schema.fields | array<FormsField> | yes | |
items[].schema.fields[].id | string | yes | |
items[].schema.fields[].type | string | yes | enum: |
items[].schema.fields[].label | string | no | |
items[].schema.fields[].name | string | yes | |
items[].schema.fields[].required | boolean | no | |
items[].schema.fields[].placeholder | string | no | |
items[].schema.fields[].help_text | string | no | |
items[].schema.fields[].default | any | no | |
items[].schema.fields[].options | array<FormsFieldOption> | no | |
items[].schema.fields[].options[].value | string | yes | |
items[].schema.fields[].options[].label | string | yes | |
items[].schema.fields[].max_length | integer | null | no | |
items[].schema.fields[].min | number | null | no | |
items[].schema.fields[].max | number | null | no | |
items[].schema.fields[].rows | integer | null | no | |
items[].schema.fields[].pattern | string | no | |
items[].schema.fields[].extra | object | no | |
items[].schema.steps | array<FormsStep> | no | |
items[].schema.steps[].id | string | yes | |
items[].schema.steps[].title | string | yes | |
items[].schema.steps[].field_ids | array<string> | yes | |
items[].schema.settings | FormsSettings | yes | |
items[].schema.settings.submit_label | string | no | |
items[].schema.settings.thank_you_message | string | no | |
items[].schema.settings.redirect_url | string | null | no | |
items[].schema.settings.honeypot | boolean | no | Se true, adiciona campo axuz_hp e rejeita submits com valor. |
items[].schema.settings.double_opt_in | boolean | no | |
items[].schema.settings.triggers | array<FormsTrigger> | no | |
items[].schema.settings.triggers[].id | string | yes | client uuid |
items[].schema.settings.triggers[].type | string | yes | enum: |
items[].schema.settings.triggers[].enabled | boolean | yes | |
items[].schema.settings.triggers[].label | string | no | |
items[].schema.settings.triggers[].mapping | object | no | |
items[].schema.settings.triggers[].config | object | no | Shape depende de |
items[].schema.settings.notify_emails | array<string<email>> | no | Legacy Fase 178. Promovido em memória pra Triggers no read. |
items[].schema.settings.webhook_url | string | no | |
items[].schema.settings.webhook_secret | string | no |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
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/'Node.js
const res = await fetch("https://api-forms.axuz.net/v1/templates/", {
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/",
timeout=30,
)
res.raise_for_status()
print(res.json())