curl --request GET \
--url https://api.gotrebol.com/v2/form-schemas/{id_schema} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.gotrebol.com/v2/form-schemas/{id_schema}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.gotrebol.com/v2/form-schemas/{id_schema}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gotrebol.com/v2/form-schemas/{id_schema}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gotrebol.com/v2/form-schemas/{id_schema}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gotrebol.com/v2/form-schemas/{id_schema}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/v2/form-schemas/{id_schema}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id_schema": "onboarding-form",
"account_id": "acc_1234567890abcdef",
"name": "Formulario de Onboarding",
"ui_schema_definition": {
"ui_order": [
"junta_directiva",
"nombre",
"apellido",
"notaria"
],
"nombre": {
"ui_type": "text",
"ui_label": "Nombre"
},
"apellido": {
"ui_type": "text",
"ui_label": "Apellido"
},
"junta_directiva": {
"ui_type": "table",
"ui_label": "Integrantes miembros de la junta directiva",
"ui_columns": {
"id_type": {
"ui_type": "select",
"ui_label": "ID",
"ui_items": [
"RFC",
"CURP"
]
},
"id_number": {
"ui_type": "text",
"ui_label": "No. de identificación"
},
"names": {
"ui_type": "text",
"ui_label": "Nombres y Apellidos"
}
}
},
"notaria": {
"ui_type": "section",
"ui_label": "Notaria",
"ui_order": [
"nombre",
"direccion",
"identidad"
],
"nombre": {
"ui_type": "text",
"ui_label": "Nombre"
},
"direccion": {
"ui_type": "text",
"ui_label": "Direccion"
},
"identidad": {
"ui_type": "section",
"ui_label": "Identidad",
"ui_order": [
"curp",
"rfc"
],
"curp": {
"ui_type": "text",
"ui_label": "CURP"
},
"rfc": {
"ui_type": "text",
"ui_label": "RFC"
}
}
}
}
}Obtener esquema por ID
Recupera un esquema de formulario específico por su id_schema
curl --request GET \
--url https://api.gotrebol.com/v2/form-schemas/{id_schema} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.gotrebol.com/v2/form-schemas/{id_schema}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.gotrebol.com/v2/form-schemas/{id_schema}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gotrebol.com/v2/form-schemas/{id_schema}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gotrebol.com/v2/form-schemas/{id_schema}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gotrebol.com/v2/form-schemas/{id_schema}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/v2/form-schemas/{id_schema}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id_schema": "onboarding-form",
"account_id": "acc_1234567890abcdef",
"name": "Formulario de Onboarding",
"ui_schema_definition": {
"ui_order": [
"junta_directiva",
"nombre",
"apellido",
"notaria"
],
"nombre": {
"ui_type": "text",
"ui_label": "Nombre"
},
"apellido": {
"ui_type": "text",
"ui_label": "Apellido"
},
"junta_directiva": {
"ui_type": "table",
"ui_label": "Integrantes miembros de la junta directiva",
"ui_columns": {
"id_type": {
"ui_type": "select",
"ui_label": "ID",
"ui_items": [
"RFC",
"CURP"
]
},
"id_number": {
"ui_type": "text",
"ui_label": "No. de identificación"
},
"names": {
"ui_type": "text",
"ui_label": "Nombres y Apellidos"
}
}
},
"notaria": {
"ui_type": "section",
"ui_label": "Notaria",
"ui_order": [
"nombre",
"direccion",
"identidad"
],
"nombre": {
"ui_type": "text",
"ui_label": "Nombre"
},
"direccion": {
"ui_type": "text",
"ui_label": "Direccion"
},
"identidad": {
"ui_type": "section",
"ui_label": "Identidad",
"ui_order": [
"curp",
"rfc"
],
"curp": {
"ui_type": "text",
"ui_label": "CURP"
},
"rfc": {
"ui_type": "text",
"ui_label": "RFC"
}
}
}
}
}Authorizations
Path Parameters
Identificador único del esquema
Response
Esquema recuperado exitosamente
Esquema de formulario público para la cuenta
Identificador único del esquema
"onboarding-form"
ID de la cuenta a la que pertenece el esquema
"acc_1234567890abcdef"
Nombre del esquema de formulario
"Formulario de Onboarding"
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.
Show child attributes
Show child attributes
{
"ui_order": [
"junta_directiva",
"nombre",
"apellido",
"notaria"
],
"nombre": { "ui_type": "text", "ui_label": "Nombre" },
"apellido": { "ui_type": "text", "ui_label": "Apellido" },
"junta_directiva": {
"ui_type": "table",
"ui_label": "Integrantes miembros de la junta directiva",
"ui_columns": {
"id_type": {
"ui_type": "select",
"ui_label": "ID",
"ui_items": ["RFC", "CURP"]
},
"id_number": {
"ui_type": "text",
"ui_label": "No. de identificación"
},
"names": {
"ui_type": "text",
"ui_label": "Nombres y Apellidos"
}
}
},
"notaria": {
"ui_type": "section",
"ui_label": "Notaria",
"ui_order": ["nombre", "direccion", "identidad"],
"nombre": { "ui_type": "text", "ui_label": "Nombre" },
"direccion": {
"ui_type": "text",
"ui_label": "Direccion"
},
"identidad": {
"ui_type": "section",
"ui_label": "Identidad",
"ui_order": ["curp", "rfc"],
"curp": { "ui_type": "text", "ui_label": "CURP" },
"rfc": { "ui_type": "text", "ui_label": "RFC" }
}
}
}
Was this page helpful?