GET
/
v2
/
form-schemas
Listar esquemas de formularios
curl --request GET \
  --url https://api.gotrebol.com/v2/form-schemas \
  --header 'x-api-key: <api-key>'
[
  {
    "id_schema": "onboarding-form",
    "account_id": "acc_1234567890abcdef",
    "name": "Formulario de Onboarding",
    "ui_schema_definition": {
      "ui_order": [
        "nombre",
        "apellido",
        "notaria"
      ],
      "nombre": {
        "ui_type": "text",
        "ui_label": "Nombre",
        "ui_description": "Nombre del cliente"
      },
      "apellido": {
        "ui_type": "text",
        "ui_label": "Apellido",
        "ui_description": "Apellido del cliente"
      },
      "notaria": {
        "ui_type": "section",
        "ui_order": [
          "nombre",
          "direccion",
          "identidad"
        ],
        "nombre": {
          "ui_type": "text",
          "ui_label": "Nombre",
          "ui_description": "Nombre de la notaria"
        },
        "direccion": {
          "ui_type": "text",
          "ui_label": "Direccion",
          "ui_description": "Direccion de la notaria"
        },
        "identidad": {
          "ui_type": "section",
          "ui_order": [
            "curp",
            "rfc"
          ],
          "curp": {
            "ui_type": "text",
            "ui_label": "CURP",
            "ui_description": "CURP de la notaria"
          },
          "rfc": {
            "ui_type": "text",
            "ui_label": "RFC",
            "ui_description": "RFC de la notaria"
          }
        }
      }
    }
  }
]

Authorizations

​
x-api-key
string
header
required

Response

Lista de esquemas recuperada exitosamente

​
id_schema
string
required

Identificador único del esquema

Example:

"onboarding-form"

​
account_id
string
required

ID de la cuenta a la que pertenece el esquema

Example:

"acc_1234567890abcdef"

​
name
string
required

Nombre del esquema de formulario

Example:

"Formulario de Onboarding"

​
ui_schema_definition
object
required

Definición de campo de esquema de interfaz de usuario. Esta estructura permite definir formularios dinámicos con campos anidados y diferentes tipos de entrada. El esquema soporta campos simples como texto, números, fechas, y campos complejos como secciones que pueden contener otros campos.

Estructura jerárquica: Los campos pueden anidarse usando el tipo "section", permitiendo crear formularios con múltiples niveles de organización.

Validación automática: El sistema valida automáticamente que todos los campos referenciados en ui_order existan como propiedades en el mismo nivel.

Example:
{
  "ui_order": ["nombre", "apellido", "notaria"],
  "nombre": {
    "ui_type": "text",
    "ui_label": "Nombre",
    "ui_description": "Nombre del cliente"
  },
  "apellido": {
    "ui_type": "text",
    "ui_label": "Apellido",
    "ui_description": "Apellido del cliente"
  },
  "notaria": {
    "ui_type": "section",
    "ui_order": ["nombre", "direccion", "identidad"],
    "nombre": {
      "ui_type": "text",
      "ui_label": "Nombre",
      "ui_description": "Nombre de la notaria"
    },
    "direccion": {
      "ui_type": "text",
      "ui_label": "Direccion",
      "ui_description": "Direccion de la notaria"
    },
    "identidad": {
      "ui_type": "section",
      "ui_order": ["curp", "rfc"],
      "curp": {
        "ui_type": "text",
        "ui_label": "CURP",
        "ui_description": "CURP de la notaria"
      },
      "rfc": {
        "ui_type": "text",
        "ui_label": "RFC",
        "ui_description": "RFC de la notaria"
      }
    }
  }
}