Obtener formulario público GET
Lee un formulario activo tal como lo ve el navegador de un visitante: sus campos y su diseño, sin nada privado. Sin autenticación. Este es el endpoint que llama la propia página del formulario.
Endpoint
GET https://api.pocketalert.app/v1/forms/{tid}Autenticación
No requerida
El endpoint es público. Nunca devuelve el título de la notificación push, el enrutamiento, el contador de respuestas ni nada más que vea el propietario.
Petición
Parámetros de ruta
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tid | string | ✅ | Identificador del formulario, el mismo que aparece en https://frms.click/{tid} |
Ejemplo de petición
bash
curl -X GET "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9"javascript
const form = await fetch('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9')
.then((response) => response.json());
if (form.closed) {
console.log(form.settings.closed_message);
} else {
console.log(form.settings.title, form.fields.length, 'fields');
}python
import requests
form = requests.get('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9').json()
print(form['settings']['title'], len(form['fields']), 'fields')Respuesta
Respuesta exitosa
200 OK
Un formulario cerrado sigue respondiendo con 200, con closed: true y un array fields vacío. Así la página sabe que debe mostrar closed_message en lugar de los campos.
| Campo | Tipo | Descripción |
|---|---|---|
tid | string | Identificador del formulario |
closed | boolean | true cuando el formulario está desactivado, pasada su fecha de cierre o sin plazas de respuesta disponibles |
fields | array | Los campos a renderizar; consulta Crear formulario. Vacío cuando closed es true |
settings | object | Título, textos y diseño; consulta Crear formulario |
allowed_origins | array | Hosts autorizados a incrustar el formulario; vacío significa cualquiera |
json
{
"tid": "vml19aihrga216gt8apc5e3m9",
"closed": false,
"fields": [
{ "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
{ "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true },
{ "id": "src", "type": "hidden", "label": "Source", "param": "utm_source" }
],
"settings": {
"title": "Get in touch",
"top_text": "We reply within one business day.",
"success_message": "Thanks! Your response has been sent.",
"closed_message": "This form is no longer accepting responses.",
"background_color": "#f5f5f4",
"card_color": "#ffffff",
"text_color": "#1c1917",
"primary_color": "#3f5cad",
"font_family": "Inter",
"font_size": 16,
"font_weight": 400,
"border_radius": 10,
"hide_branding": false,
"submit": { "text": "Submit", "color": "", "size": "md" }
},
"allowed_origins": []
}Campos ocultos
Un campo hidden no se renderiza. Su valor procede de la URL de la página: ?utm_source=newsletter rellena el campo cuyo param es utm_source, y se envía con la respuesta.
Respuestas de error
| Estado | Descripción |
|---|---|
404 | Formulario no encontrado |