Saltar al contenido principal

Listar formularios

GET/v1/forms

Para desarrolladores

Descripción​

Lista los formularios de la cuenta. Un formulario define una secuencia de ítems (campos, ítems de consentimiento, separadores y bloques de texto) que se muestran en el orden configurado.

Guía relacionada​

  • Formularios — Arme formularios de captura y revise lo que se envió.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope form:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Query params:

pageinteger
Número de página; la primera es la 1. Default: 1.
page_sizeinteger
Tamaño de página, 1–100. Default: 20.
kindstring, enum: `consent | advanced` | null
consent: formularios simples generados por el módulo de consentimiento (solo el identificador y los ítems de consentimiento). advanced: formularios armados libremente con cualquier campo del catálogo. Si se omite, no se filtra.
typestring, enum: `registration | update` | null
Filtra por el tipo del formulario. Si se omite, no se filtra.
is_activeboolean | null
Filtra por si el formulario está activo. Si se omite, no se filtra.
namestring | null
Filtra por nombre, con coincidencia parcial e insensible a mayúsculas.
requires_confirmationboolean | null
Filtra por si el formulario exige doble confirmación.
auto_reply_sender_idinteger | null
Filtra por el remitente configurado en el formulario, que se usa tanto para la respuesta automática como para el correo de doble confirmación.

Response​

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene los campos que siguen.
idintegersiempre presente
Identificador del formulario.
namestringsiempre presente
Nombre del formulario.
kindstring, enum: `consent | advanced`siempre presente
consent: formulario generado por el módulo de consentimiento. advanced: formulario armado con cualquier campo del catálogo.
typestring, enum: `registration | update`siempre presente
registration: capta contactos nuevos. update: actualiza datos de un contacto existente.
dataset_idinteger | null
Dataset que alimentan las respuestas confirmadas de este formulario, si está vinculado a uno.
public_tokenstringsiempre presente
Token que identifica al formulario en su URL o inserción pública.
is_defaultbooleansiempre presente
—
is_activebooleansiempre presente
true cuando el formulario está activo y acepta envíos.
settingsobject | null
Textos públicos del formulario (title, header_text, footer_text) y diseño de su página pública (design: primary_color, secondary_color, logo_url, custom_css), forma libre.
created_atstring (date-time)siempre presente
Fecha y hora de creación.
updated_atstring (date-time)siempre presente
Fecha y hora de la última modificación.
itemsobject[]siempre presente
Los ítems del formulario, con la misma forma que en `GET /v1/forms/{id}`.
Request
curl -X GET "https://$API_HOST/v1/forms?kind=advanced" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "id": 5,
    "name": "Suscripción newsletter",
    "kind": "advanced",
    "type": "registration",
    "dataset_id": null,
    "public_token": "f3b1c2...",
    "is_default": false,
    "is_active": true,
    "settings": {
      "title": "Súmate a nuestras novedades"
    },
    "created_at": "2026-05-08T14:22:31Z",
    "updated_at": "2026-05-08T14:22:31Z",
    "items": []
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}