GET /teams/{teamId}/forms/{formId}

Detalhe do form

Access: Team member
Service: https://api-forms.axuz.net

Accepted authentication

sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— GET /teams/{teamId}/forms/{formId}. Detalhe do form.

Motivo: tela de edição precisa do schema completo (fields, settings, triggers). Escopado por team + soft-delete filter.

Comportamento: teamAndUser + parseFormID → repo.GetByID. 404 se não encontrado ou deleted_at setado.

Entradas: path {teamId}, {formId}.

Retorno: 200 Form, 400, 401, 404, 500.

Parameters

Name	In	Type	Required	Description
`teamId`	path	`string`	yes
`formId`	path	`string`	yes

Responses

200
Form

Name	Type	Required	Description
`id`	`string<uuid>`	yes
`team_id`	`string<uuid>`	yes
`slug`	`string`	yes
`name`	`string`	yes
`description`	`string \| null`	no
`schema`	`FormsFormSchema`	yes
`schema.fields`	`array<FormsField>`	yes
`schema.fields[].id`	`string`	yes
`schema.fields[].type`	`string`	yes	enum: `"text", "email", "phone", "textarea", "number", "select", "radio", "checkbox", "date", "url", "file", "hidden"`
`schema.fields[].label`	`string`	no
`schema.fields[].name`	`string`	yes
`schema.fields[].required`	`boolean`	no
`schema.fields[].placeholder`	`string`	no
`schema.fields[].help_text`	`string`	no
`schema.fields[].default`	`any`	no
`schema.fields[].options`	`array<FormsFieldOption>`	no
`schema.fields[].options[].value`	`string`	yes
`schema.fields[].options[].label`	`string`	yes
`schema.fields[].max_length`	`integer \| null`	no
`schema.fields[].min`	`number \| null`	no
`schema.fields[].max`	`number \| null`	no
`schema.fields[].rows`	`integer \| null`	no
`schema.fields[].pattern`	`string`	no
`schema.fields[].extra`	`object`	no
`schema.steps`	`array<FormsStep>`	no
`schema.steps[].id`	`string`	yes
`schema.steps[].title`	`string`	yes
`schema.steps[].field_ids`	`array<string>`	yes
`schema.settings`	`FormsSettings`	yes
`schema.settings.submit_label`	`string`	no
`schema.settings.thank_you_message`	`string`	no
`schema.settings.redirect_url`	`string \| null`	no
`schema.settings.honeypot`	`boolean`	no	Se true, adiciona campo axuz_hp e rejeita submits com valor.
`schema.settings.double_opt_in`	`boolean`	no
`schema.settings.triggers`	`array<FormsTrigger>`	no
`schema.settings.triggers[].id`	`string`	yes	client uuid
`schema.settings.triggers[].type`	`string`	yes	enum: `"email", "webhook", "calendar_event", "workspace_task"`
`schema.settings.triggers[].enabled`	`boolean`	yes
`schema.settings.triggers[].label`	`string`	no
`schema.settings.triggers[].mapping`	`object`	no
`schema.settings.triggers[].config`	`object`	no	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_emails`	`array<string<email>>`	no	Legacy Fase 178. Promovido em memória pra Triggers no read.
`schema.settings.webhook_url`	`string`	no
`schema.settings.webhook_secret`	`string`	no
`layout`	`string`	yes	Layout resolvido via ResolveLayout.
`status`	`string`	yes	enum: `"draft", "published", "archived"`
`submit_count`	`integer`	yes
`created_by`	`string<uuid> \| null`	no
`created_at`	`string<date-time>`	yes
`updated_at`	`string<date-time>`	yes
`deleted_at`	`string<date-time> \| null`	no

400
Parâmetro/body inválido

Name	Type	Required	Description
`error`	`string`	yes

401
Sem auth ou JWT inválido

Name	Type	Required	Description
`error`	`string`	yes

403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

Name	Type	Required	Description
`error`	`string`	yes

404
Recurso não encontrado

Name	Type	Required	Description
`error`	`string`	yes

429
Limite de requisições excedido.

Name	Type	Required	Description
`error`	`string`	yes

500
Erro inesperado

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/teams/TEAM_ID/forms/FORM_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://api-forms.axuz.net/teams/TEAM_ID/forms/FORM_ID", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
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/teams/TEAM_ID/forms/FORM_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())

GET /teams/{teamId}/forms/{formId}

Accepted authentication

Parameters

Responses

200 Form

400 Parâmetro/body inválido

401 Sem auth ou JWT inválido

403 Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

404 Recurso não encontrado

429 Limite de requisições excedido.

500 Erro inesperado