Listar formularios

GET/v1/forms

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.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope form:read. Formato: Bearer FD.<key_id>.<token>.

X-Instance-Slugstringheaderobligatorio

Request

Query params:

pageinteger

Página, 1-indexed. 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 identificador + ítems de consentimiento). advanced: formularios armados libremente con cualquier campo del catálogo. Omitido: sin filtro.

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.

idintegerobligatorio

Identificador del formulario.

namestringobligatorio

—

kindstring, enum: `consent | advanced`obligatorio

Ver descripción del parámetro kind.

typestring, enum: `acquisition | update`obligatorio

acquisition: capta contactos nuevos. update: actualiza datos de un contacto existente.

dataset_idinteger | null

Dataset al que se asocian las respuestas, si el formulario está vinculado a uno.

public_tokenstringobligatorio

Token que identifica al formulario en su URL/embed público.

is_defaultbooleanobligatorio

—

is_activebooleanobligatorio

—

settingsobject | null

Textos públicos del formulario (title, header_text, footer_text), forma libre.

created_atstring (date-time)obligatorio

—

updated_atstring (date-time)obligatorio

—

itemsobject[]obligatorio

Los ítems del formulario, en el mismo listado ya resueltos — ver la forma completa 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": "acquisition",
    "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
}
}