---
title: "Obter formulário"
method: POST
path: "/api/management/get-form"
tags: ["forms"]
---

# Obter formulário

`POST /api/management/get-form`

Retorna um formulário com todos os seus campos, inclusive os arquivados (com `deleted_at` preenchido), e as regras condicionais de cada campo.

## Request body

- object — Identificação do formulário.
  - `form_id` integer, required — ID do formulário.

## Response `200`

Sucesso

- object — Formulário encontrado.
  - `response` boolean — Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.
  - `form` object — Dados do formulário.
    - `id` integer — ID do formulário.
    - `title` string — Título do formulário.
    - `frame_id` string, uuid — ID da conta dona do formulário.
    - `created_at` string, date-time — Data de criação do formulário.
    - `updated_at` string, date-time — Data da última alteração do formulário.
    - `deleted_at` string, date-time, nullable — Data de exclusão do formulário. Nulo quando ativo.
    - `edges` object[] — Campos do formulário, ordenados por index.
      - `id` integer — ID do campo.
      - `type` 'short_text' | 'long_text' | 'rich_text' | 'attachment' | 'checkbox' | 'user' | 'date' | 'date_and_time' | 'email' | 'phone' | 'select' | 'radio' | 'currency' | 'number' | 'link' | 'time' | 'contact' | 'customer' | 'project' | 'counter' | 'matrix' — Tipo do campo.
      - `label` string — Rótulo do campo.
      - `index` integer — Posição do campo no formulário (ordem crescente).
      - `help_text` string, nullable — Texto de ajuda exibido junto ao campo.
      - `description` string, nullable — Descrição do campo.
      - `options` union — Opções do campo: lista de textos para select, radio e checkbox; objeto com rows/columns para matrix; lista vazia nos demais tipos.
        - string[]
        - object
      - `initial_value` union — Valor pré-preenchido do campo, no mesmo formato de uma resposta daquele tipo.
        - string
        - number
        - unknown[]
          - unknown
        - object
      - `required` boolean — Se o preenchimento é obrigatório.
      - `custom_validation` string, nullable — Expressão regular que a resposta precisa atender.
      - `conditional` unknown
      - `form_id` integer — ID do formulário ao qual o campo pertence.
      - `created_at` string, date-time — Data de criação do campo.
      - `updated_at` string, date-time — Data da última alteração do campo.
      - `deleted_at` string, date-time, nullable — Data em que o campo foi arquivado. Nulo quando ativo.
      - `is_multiple` boolean — Se o campo aceita mais de um valor (ex.: vários links ou usuários).
      - `logical_operator` 'and' | 'or' — Como as regras condicionais do campo se combinam.
      - `is_migrated` boolean — Marcador interno de migração de dados. Pode ser ignorado.
      - `conditional_action` 'show' | 'hide' | 'null', nullable — O que acontece com o campo quando as regras são atendidas: show (exibe) ou hide (oculta). Nulo quando não há lógica condicional.
      - `conditionals` object[] — Regras condicionais do campo.
        - `id` integer — ID da regra.
        - `form_edge_id` integer — ID do campo que é mostrado ou ocultado pela regra.
        - `target_id` integer — ID do campo cuja resposta é avaliada.
        - `operator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'greater_than' | 'less_than' | 'is_empty' | 'is_not_empty' | 'starts_with' | 'ends_with' | 'greater_than_or_equals' | 'less_than_or_equals' — Operador de comparação.
        - `value` union — Valor comparado com a resposta do campo avaliado.
          - string
          - number
          - string[]

## Other responses

- `404` — Não encontrado

## Changes

- **2026-09-22** `d71b18b1685d` — 12 breaking, 26 warning, 6 info
  - the request property `form_id` became not nullable
  - the request property `form_id` became required
  - the `form_id` request property type changed from no type to `integer`
  - the response property `form/edges/items/help_text` became nullable for the status `200`
  - …40 more
- **2026-09-22** `b43a04f35145` — 3 info
  - added optional request body
  - added the media type `application/json` for the response with the status `200`
  - added the non-success response with the status `404`

[Change history](https://skmtc.dev/olie-ai/apis/olie-api/changes/api/management/get-form/post.md)

---

[API](https://skmtc.dev/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.dev/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc.dev/olie-ai/apis/olie-api/revisions/d7bda7d32f67?raw)