Métodos de la API

Lista los formularios de un espacio de trabajo. Admite paginación por cursor y búsqueda difusa opcional por nombre.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "forms.list",
    "params": { "workspaceId": "ws_abc123" }
  }'

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "frm_abc123",
        "name": "Contact Form",
        "folderId": null,
        "workspaceId": "ws_abc123",
        "isPublished": true,
        "publishedAt": 1714041851000,
        "unpublishedAt": null,
        "createdAt": 1714041800000,
        "lastEditedAt": 1714042000000,
        "emoji": null
      }
    ],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Obtiene los detalles completos de un formulario, incluidas las preguntas, la portada, el logotipo y una URL de vista previa.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "forms.get",
    "params": { "formId": "frm_abc123" }
  }'

{
  "ok": true,
  "data": {
    "id": "frm_abc123",
    "name": "Event Feedback",
    "folderId": null,
    "workspaceId": "ws_abc123",
    "isPublished": true,
    "publishedAt": 1714041851000,
    "unpublishedAt": null,
    "createdAt": 1714041800000,
    "lastEditedAt": 1714042000000,
    "emoji": null,
    "questions": [
      {
        "id": "q_1",
        "type": "email-input",
        "inputType": "email",
        "title": "Your email",
        "metadata": null
      },
      {
        "id": "q_2",
        "type": "rating-input",
        "inputType": "rating",
        "title": "Overall experience",
        "metadata": { "kind": "rating", "maxStars": 5 }
      }
    ],
    "hasContent": true,
    "cover": null,
    "logo": null,
    "isDeleted": false,
    "trashedAt": null,
    "previewUrl": "https://formbase.so/preview/abc..."
  }
}

Crea un nuevo formulario vacío. Devuelve el formulario y una URL de vista previa.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "forms.create",
    "params": {
      "name": "Contact",
      "workspaceId": "ws_abc123"
    }
  }'

const res = await fetch('https://api.formbase.so/api/v1', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FORMBASE_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    method: 'forms.create',
    params: { name: 'Contact', workspaceId: 'ws_abc123' },
  }),
})
const { ok, data } = await res.json()

import os, requests
res = requests.post(
  "https://api.formbase.so/api/v1",
  headers={"Authorization": f"Bearer {os.environ['FORMBASE_TOKEN']}"},
  json={
    "method": "forms.create",
    "params": {
      "name": "Contact",
      "workspaceId": "ws_abc123",
    },
  },
)
data = res.json()

{
  "ok": true,
  "data": {
    "id": "frm_new123",
    "name": "Contact",
    "workspaceId": "ws_abc123",
    "folderId": null,
    "isPublished": false,
    "createdAt": 1714041851000,
    "previewUrl": "https://formbase.so/preview/abc..."
  }
}

Actualiza los metadatos del formulario: nombre, carpeta, emoji, portada o logotipo. No actualiza el contenido del formulario (usa las herramientas del editor para eso).

Pasa al menos uno de los cinco campos actualizables. No cambia el contenido del formulario — usa las herramientas del editor de MCP para eso.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "forms.update",
    "params": {
      "formId": "frm_abc123",
      "name": "Updated Name",
      "emoji": "📋"
    }
  }'

{
  "ok": true,
  "data": {
    "id": "frm_abc123",
    "name": "Updated Name",
    "folderId": null,
    "emoji": "📋"
  }
}

cover y logo solo vuelven cuando los enviaste. Un payload que coincidía con el estado actual en todos los campos escalares añade noChange: true.

Publica un formulario para que pueda recibir respuestas, y congela sus claves de campo en una nueva instantánea. Idempotente: un formulario ya publicado devuelve éxito con alreadyPublished: true, y un formulario despublicado se vuelve a publicar desde su última instantánea.

Un formulario con bloques de contenido pero sin preguntas se publica con una advertencia. Un formulario sin ningún contenido no se puede publicar. Publicar no crea una URL pública — llama a shareLinks.create para eso.

Pone un formulario fuera de línea. Los respondentes ya no pueden abrirlo. Idempotente — un formulario que no está publicado devuelve alreadyUnpublished: true. Reversible con forms.publish.

Mueve un formulario a la papelera. Sus enlaces para compartir activos se revocan, así que sus URLs públicas dejan de funcionar.

Restaura un formulario desde la papelera.

Un formulario que no está en la papelera devuelve alreadyRestored: true.

Lee los ajustes de comportamiento de un formulario.

Devuelve { settings, isDefault, availableEmailDomains, defaultFromAddress, payment }. isDefault es true cuando el formulario aún no tiene una fila de ajustes guardada y estás viendo los valores por defecto. availableEmailDomains contiene los ids de dominio verificados que puedes pasar como emailDomainId, y payment indica si Stripe está conectado (conectarlo es un paso desde el panel).

Actualiza los ajustes de comportamiento de un formulario. Una actualización parcial: solo se escriben los campos que envías.

Los asuntos y cuerpos son texto plano y aceptan marcadores {{variable}}; los saltos de línea se convierten en párrafos. Personalizar un asunto o cuerpo de respondente lo hace traducible, así que sus claves aparecen de inmediato en translations.listEntries.

Lista las respuestas de un formulario, la página más reciente primero, con paginación por cursor.

{
  "ok": true,
  "data": {
    "formId": "frm_abc123",
    "formName": "Event Feedback",
    "items": [
      {
        "id": "sub_xyz789",
        "submittedAt": "2026-05-18 18:02:28",
        "isCompleted": true,
        "createdAt": "2026-05-18 18:02:19",
        "answers": {
          "email": "user@example.com",
          "plan": "pro",
          "contacts": [{ "name": "Ada" }, { "name": "Grace" }]
        },
        "display": {
          "email": "user@example.com",
          "plan": "Pro",
          "contacts": "Ada, Grace"
        }
      }
    ],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Obtiene un enlace al PDF de una respuesta. Construido para el conector de Zapier: solo devuelve un resultado cuando el formulario tiene una integración de Zapier activa configurada para incluir el PDF, y el PDF se conservó.

{
  "ok": true,
  "data": {
    "url": "https://api.formbase.so/api/storage/...",
    "filename": "formbase-submission-sub_xyz789.pdf",
    "contentType": "application/pdf",
    "byteLength": 148213
  }
}

Construye un payload de respuesta de muestra para un formulario, sin ningún dato real. Es exactamente la forma que lleva una entrega de respuesta de enlace público, así que los conectores lo usan para descubrir campos; una respuesta nacida de una solicitud llega a una suscripción como request.completed en su lugar, muestreada por

requests.sample. data.form.snapshotId es la versión publicada actual del formulario, el mismo id que llevan los eventos en vivo, o null mientras el formulario no esté publicado.

{
  "ok": true,
  "data": {
    "id": "evt_example000000000000",
    "type": "submission.completed",
    "createdAt": "2026-05-18T19:00:00.000Z",
    "apiVersion": "2026-09-24",
    "test": true,
    "data": {
      "form": { "id": "frm_abc123", "name": "Event Feedback", "snapshotId": "js7abc123" },
      "submission": {
        "id": "sub_example000000000000",
        "respondentEmail": "respondent@example.com",
        "submittedAt": "2026-05-18T19:00:00.000Z",
        "updatedAt": null,
        "editCount": 0,
        "pdfUrl": null,
        "language": "en"
      },
      "answers": { "your_email": "john@example.com" },
      "display": { "your_email": "john@example.com" }
    }
  }
}

La semántica de los campos y del payload está documentada una sola vez, en la referencia de webhooks.

Lista los enlaces compartidos de un formulario.

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "sl_abc123",
        "code": "RPjNes52",
        "url": "https://formbase.so/RPjNes52",
        "customDomainUrl": null,
        "formId": "frm_abc123",
        "createdAt": 1714041851000,
        "expiresAt": null,
        "maxClaims": null,
        "claimedCount": 7,
        "isRevoked": false,
        "revokedAt": null,
        "customDomainId": null,
        "customSlug": null
      }
    ],
    "availableCustomDomains": [],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Crea un enlace compartido para un formulario. El formulario debe estar publicado primero.

La respuesta es el enlace compartido (con la misma forma que un elemento de shareLinks.list) más availableCustomDomains, para que puedas continuar con shareLinks.update y asociar uno.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "shareLinks.create",
    "params": {
      "formId": "frm_abc123",
      "maxClaims": 100
    }
  }'

Actualiza un enlace compartido. Puedes cambiar el vencimiento, el número máximo de usos, el dominio personalizado, el slug, o revocar el enlace.

Lista todos los campos de la versión publicada actual de un formulario, con la clave para dirigirte a cada uno. Llama a esto antes de requests.create en lugar de codificar las claves a mano. Consulta Claves de campo.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "fields.list",
    "params": { "formId": "j57..." }
  }'

{
  "ok": true,
  "data": {
    "published": true,
    "items": [
      { "key": "company_name", "type": "text", "title": "Company", "required": true, "prefillable": true },
      {
        "key": "company_size", "type": "select", "title": "Company size", "required": false, "prefillable": true,
        "options": [
          { "key": "1_50", "label": "1–50" },
          { "key": "51_200", "label": "51–200" }
        ]
      },
      {
        "key": "satisfaction", "type": "matrix", "title": "How did we do?", "required": false, "prefillable": true,
        "rows": [{ "key": "delivery_speed", "label": "Delivery speed" }],
        "columns": [{ "key": "very_good", "label": "Very good" }, { "key": "poor", "label": "Poor" }]
      },
      { "key": "case_id", "type": "hidden", "title": "Case", "required": false, "prefillable": false, "context": true },
      { "key": "total", "type": "number", "title": "Total", "required": false, "prefillable": false, "calculated": true }
    ],
    "hasMore": false
  }
}

Un grupo repetitivo es type: “group” con repeating: true y un array members. Un bloque de Documentos es type: “documents” y lleva documents: [{ name }], los archivos de autor que todo respondente ya ve.

Crea una solicitud. Gasta una unidad del cupo mensual del espacio de trabajo, responda o no el destinatario.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "requests.create",
    "params": {
      "formId": "j57...",
      "recipient": { "email": "ada@acme.com", "name": "Ada" },
      "prefill": { "company_name": "Acme" },
      "readonly": ["company_name"],
      "context": { "case_id": "CASE-9" },
      "delivery": "email",
      "externalId": "run-42",
      "callbackUrl": "https://automation.example/webhook/resume-abc",
      "idempotencyKey": "run-42"
    }
  }'

{
  "ok": true,
  "data": {
    "id": "kd7...",
    "status": "pending",
    "url": "https://form.formbase.so/r/rq_...",
    "deliveryStatus": "queued",
    "expiresAt": 1794787200000,
    "createdAt": 1789379200000,
    "externalId": "run-42",
    "deduplicated": false
  }
}

deliveryStatus es not_requested hasta que se pone en cola una invitación, luego queued → sent o failed, y bounced en cuanto el proveedor de correo reporta un rebote definitivo o una queja.

Obtén una solicitud completa: estado, resultado, lo que se precompletó, su cronología y — una vez completada — answers y

display indexados por clave de campo, los mismos dos mapas que lleva el callback.

{
  "ok": true,
  "data": {
    "id": "kd7...",
    "formId": "j57...",
    "status": "completed",
    "outcome": "approve",
    "isTest": false,
    "recipient": { "email": "ada@acme.com", "name": "Ada" },
    "language": "en",
    "externalId": "run-42",
    "metadata": null,
    "context": { "case_id": "CASE-9" },
    "prefill": { "company_name": "Acme" },
    "readonlyKeys": ["company_name"],
    "delivery": "email",
    "deliveryStatus": "sent",
    "hasCallback": true,
    "callbackFailedAt": null,
    "submissionId": "kp2...",
    "url": "https://form.formbase.so/r/rq_...",
    "answers": { "company_name": "Acme", "decision": "approve" },
    "display": { "company_name": "Acme", "decision": "Approve" },
    "timeline": [
      { "id": "kd7...:created", "type": "created", "at": 1789379200000 },
      { "id": "kd7...:completed", "type": "completed", "at": 1789465600000 }
    ],
    "expiresAt": 1794787200000,
    "completedAt": 1789465600000
  }
}

El ejemplo anterior está recortado. Una respuesta completa también lleva workspaceId, formSnapshotId, createdVia, documents, reminderStep, remindersSent, reminderDueAt, dataPurgedAt, y el resto de las marcas de tiempo (updatedAt, openedAt, startedAt, lastActivityAt, expiredAt, canceledAt, canceledBy, cancelReason).

Dos campos te dicen cuándo la copia que tienes delante es la única copia. callbackFailedAt está establecido mientras el callback de esta solicitud se ha quedado sin intentos, y se limpia en cuanto uno llega o lo repites. dataPurgedAt se establece una vez que la retención elimina la solicitud: context, prefill y metadata vuelven vacíos, readonlyKeys y documents son [], y submissionId, answers y display son null.

timeline se deriva, del más antiguo al más reciente. Cada entrada tiene un id, un at, y un type — created, invitation, reminder, opened, started, completed, expired, canceled, callback. Las entradas de entrega añaden deliveryStatus y attemptCount, y los callbacks añaden eventType. Las filas de entrega se conservan 30 días, así que las cronologías más antiguas se reducen a las marcas de tiempo.

Lista las solicitudes de un espacio de trabajo o de un formulario, las más recientes primero. Las solicitudes de prueba se omiten a menos que las pidas.

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "kd7...",
        "formId": "j57...",
        "status": "pending",
        "outcome": null,
        "recipient": { "email": "ada@acme.com", "name": "Ada" },
        "externalId": "run-42",
        "deliveryStatus": "sent",
        "expiresAt": 1794787200000,
        "createdAt": 1789379200000
      }
    ],
    "nextCursor": null,
    "hasMore": false
  }
}

Los elementos de la lista llevan los mismos campos que requests.get salvo url, answers, display y timeline, y cada uno lleva isTest. Da workspaceId o formId — no dar ninguno es 400 VALIDATION_ERROR con motivo SCOPE_REQUIRED. outcome tiene prioridad sobre status, ya que solo una solicitud completada tiene un veredicto.

Retira una solicitud pendiente. El enlace deja de funcionar, el destinatario ve un aviso de retirada, y se dispara un callback request.canceled.

Envía un correo al destinatario ahora, sin tocar el calendario de recordatorios. Necesita un correo del destinatario y un plan Pro o Business.

Se aplican dos límites: al menos 10 minutos entre recordatorios manuales, y como máximo 8 recordatorios por solicitud en total, manuales y programados juntos. El calendario automático no se toca — reminderStep y reminderDueAt quedan como estaban.

Reenvía el callback que disparó una solicitud al terminar — mismo payload, mismo id de evento, para que un receptor que ya lo procesó pueda deduplicarlo. Úsalo tras arreglar un endpoint que fallaba.

{
  "ok": true,
  "data": { "dispatchId": "kf9...", "eventId": "evt_kf9..." }
}

Construye un evento de solicitud de muestra para un formulario, sin ninguna solicitud real. Es exactamente el envoltorio que recibe una suscripción a request_* creada con webhooks.create, así que los conectores lo usan para descubrir campos. Una muestra completada lleva las mismas respuestas de ejemplo que muestra

submissions.sample; una muestra expirada o cancelada lleva solo el bloque request.

{
  "ok": true,
  "data": {
    "id": "evt_example000000000000",
    "type": "request.completed",
    "createdAt": "2026-05-18T19:00:00.000Z",
    "apiVersion": "2026-09-24",
    "test": true,
    "data": {
      "request": {
        "id": "req_example000000000000",
        "externalId": "order-1234",
        "status": "completed",
        "language": "en",
        "recipient": { "email": "recipient@example.com", "name": "Sample Recipient" },
        "metadata": { "source": "sample" },
        "context": {},
        "createdAt": "2026-05-18T18:00:00.000Z",
        "completedAt": "2026-05-18T19:00:00.000Z"
      },
      "form": { "id": "frm_abc123", "name": "Event Feedback", "snapshotId": "js7abc123" },
      "submission": {
        "id": "sub_example000000000000",
        "respondentEmail": "respondent@example.com",
        "submittedAt": "2026-05-18T19:00:00.000Z",
        "updatedAt": null,
        "editCount": 0,
        "pdfUrl": null,
        "language": "en"
      },
      "answers": { "your_email": "john@example.com" },
      "display": { "your_email": "john@example.com" }
    }
  }
}

El bloque request y el resultado están documentados en la página de callbacks; la mitad de la respuesta en la referencia de webhooks. Los ids de muestra son los marcadores fijos que se muestran arriba y test es true, así que un receptor puede distinguir una muestra de un evento real.

Reserva una subida para un archivo que entregarás a un destinatario a través del bloque de Documentos del formulario. Los bytes nunca pasan por esta API: obtienes un PUT prefirmado, subes el archivo, y requests.create verifica el objeto antes de que la solicitud exista.

{
  "ok": true,
  "data": {
    "id": "kn7...",
    "name": "Lease contract draft",
    "contentType": "application/pdf",
    "size": 412000,
    "uploadUrl": "https://...",
    "expiresAt": 1792198800000
  }
}

Haz un PUT de los bytes en bruto a uploadUrl antes de que pase una hora, con Content-Type ajustado al tipo que declaraste, y luego referencia el id desde requests.create:

{
  "method": "requests.create",
  "params": {
    "formId": "j57...",
    "documents": [
      { "documentId": "kn7...", "name": "Your lease contract" },
      { "documentId": "kn8...", "field": "attachments" }
    ]
  }
}

• field es la clave de campo del bloque de Documentos. Opcional cuando el formulario tiene exactamente un bloque; obligatorio con dos o más.

• Los documentos de autor del bloque permanecen; los tuyos aparecen debajo de ellos, solo para este destinatario.
• Límites: 25 MB por documento, 100 MB de documentos por solicitud, 20 documentos mostrados por bloque incluyendo los de autor.

• Una subida puede ser referenciada por cualquier número de solicitudes. Una subida que nadie referencia caduca. Los bytes cuentan contra el almacenamiento del propietario del espacio de trabajo hasta que la retención elimina la última solicitud que los referencia.

Todo fallo aquí es 400 VALIDATION_ERROR con un details.reason: DOCUMENT_TYPE_NOT_ALLOWED, DOCUMENT_TOO_LARGE, INVALID_DOCUMENT_NAME o INVALID_DOCUMENT_SHA256 de este método, y DOCUMENT_NOT_FOUND, DOCUMENT_NOT_UPLOADED (te saltaste el PUT), DOCUMENT_INVALID, INVALID_DOCUMENT_TARGET, DOCUMENTS_TOO_LARGE o DOCUMENTS_TOO_MANY de requests.create.

Lista las suscripciones de webhook de un formulario.

{
  "ok": true,
  "data": {
    "items": [
      {
        "subscriptionId": "int_abc123",
        "formId": "frm_abc123",
        "provider": "zapier",
        "targetUrl": "https://hooks.zapier.com/...",
        "eventType": "submission_created",
        "status": "active",
        "createdAt": 1714041851000
      }
    ],
    "hasMore": false
  }
}

Suscribe una URL a eventos del formulario: respuestas nuevas o abandonadas, o solicitudes del formulario al terminar. La URL debe usar HTTPS.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "webhooks.create",
    "params": {
      "formId": "frm_abc123",
      "targetUrl": "https://hooks.zapier.com/hooks/catch/...",
      "provider": "zapier",
      "eventType": "submission_created",
      "signingSecret": "whsec_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
    }
  }'

{
  "ok": true,
  "data": {
    "subscriptionId": "int_new123",
    "formId": "frm_abc123",
    "provider": "zapier",
    "targetUrl": "https://hooks.zapier.com/hooks/catch/...",
    "eventType": "submission_created"
  }
}

Las suscripciones de respuestas abandonadas devuelven el idleWindow elegido tanto en webhooks.create como en webhooks.list. Cualquier otra suscripción lo omite.

Una suscripción de solicitudes escucha los mismos eventos que un callback, pero como su propia entrega: su propio id de evento, su propia firma y su propio presupuesto de cinco reintentos, tras el cual la suscripción se pausa. Una solicitud creada con callbackUrl en un formulario con una suscripción request_completed se dispara entonces dos veces, una a cada receptor. requests.replayCallback reenvía solo el callback. Usa requests.sample para ver el payload antes de que ninguna solicitud haya terminado.

Elimina una suscripción de webhook.

{
  "ok": true,
  "data": {
    "subscriptionId": "int_abc123",
    "deleted": true
  }
}

Obtiene métricas de analíticas agregadas de un formulario. Admite filtros por rango de fechas, dispositivo, fuente de tráfico y país.

Las analíticas son una función Pro, y la regla sigue el plan del propietario del espacio de trabajo, igual que la pestaña Analíticas del panel. Si el propietario no tiene Pro, la llamada devuelve UPGRADE_REQUIRED — también para el historial registrado cuando sí lo tenía. Un miembro Free en el espacio de un propietario Pro sí recibe los datos.

Las tasas son números de 0 a 100, los recuentos son enteros, y totalEvents es el número de filas de eventos en bruto antes de la deduplicación en visitantes únicos.

{
  "ok": true,
  "data": {
    "formId": "frm_abc123",
    "period": { "from": null, "to": null },
    "totalEvents": 17,
    "metrics": {
      "views": 7,
      "uniqueVisitors": 7,
      "engaged": 6,
      "submissions": 4,
      "engagementRate": 86,
      "completionRate": 57,
      "bounceRate": 14
    },
    "breakdown": {
      "byBrowser": { "Chrome": 17 },
      "byCountry": { "US": 10, "DE": 7 },
      "byDevice": { "desktop": 14, "mobile": 3 },
      "bySource": { "Direct": 12, "Google": 5 }
    }
  }
}

Lista los espacios de trabajo a los que puede acceder tu token. Sin parámetros.

Un token de API está vinculado a un espacio de trabajo, así que esto devuelve exactamente ese — incluso si tu cuenta pertenece a varios.

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "ws_abc123",
        "name": "Acme Inc",
        "createdAt": 1714041800000,
        "role": "owner"
      }
    ],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Crea un enlace de invitación para un espacio de trabajo.

{
  "ok": true,
  "data": {
    "id": "inv_abc123",
    "workspaceId": "ws_abc123",
    "code": "aBcDeFgH",
    "expiresAt": null,
    "maxUses": null,
    "uses": 0,
    "createdAt": 1714041851000
  }
}

Obtiene una invitación a un espacio de trabajo. Devuelve la misma forma que workspaces.createInvite.

Actualiza una invitación existente a un espacio de trabajo. Proporciona al menos uno de expiresAt o maxUses, o la llamada se rechaza. Devuelve la invitación actualizada.

Revoca permanentemente una invitación a un espacio de trabajo.

{
  "ok": true,
  "data": {
    "inviteId": "inv_abc123",
    "revoked": true
  }
}

Lista las carpetas de un espacio de trabajo.

{
  "ok": true,
  "data": {
    "items": [
      {
        "id": "fld_abc123",
        "name": "Customer Feedback",
        "workspaceId": "ws_abc123",
        "parentId": null,
        "createdAt": 1714041800000
      }
    ],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Crea una carpeta en un espacio de trabajo. Es idempotente: devuelve la carpeta existente si ya existe una con el mismo nombre.

{
  "ok": true,
  "data": {
    "id": "fld_new123",
    "name": "Customer Feedback",
    "workspaceId": "ws_abc123",
    "parentId": null,
    "createdAt": 1714041851000,
    "alreadyExisted": false
  }
}

Renombra una carpeta o la mueve a un padre diferente.

Elimina permanentemente una carpeta y todo su contenido (subcarpetas y formularios).

{
  "ok": true,
  "data": {
    "folderId": "fld_abc123",
    "deletedFolderIds": ["fld_abc123"],
    "deletedFormIds": ["frm_in_folder"],
    "message": "Folder and 1 form deleted."
  }
}

Lista todos los idiomas configurados en un formulario.

{
  "ok": true,
  "data": {
    "formId": "frm_abc123",
    "items": [
      {
        "language": "es",
        "completion": { "total": 15, "current": 12, "outdated": 2, "missing": 1, "suggested": 0 },
        "lastUpdatedAt": 1714041851000
      }
    ],
    "nextCursor": null,
    "hasMore": false,
    "canPaginate": false
  }
}

Registra un idioma en un formulario. Cualquier otro método de traducción falla con 404 NOT_FOUND hasta que lo hagas.

{
  "ok": true,
  "data": {
    "formId": "frm_abc123",
    "language": "es",
    "rowId": "tl_new123"
  }
}

Elimina un idioma y todas sus traducciones de un formulario.

Lista cada clave de origen para un idioma en un formulario, con su estado actual. Así es como descubres los valores de key que acepta translations.setEntry.

{
  "ok": true,
  "data": {
    "formId": "frm_abc123",
    "language": "es",
    "completion": { "total": 15, "current": 12, "outdated": 2, "missing": 1, "suggested": 0 },
    "items": [
      {
        "key": "block_q_1.title",
        "status": "current",
        "value": "[{\"text\":\"Tu correo electrónico\"}]",
        "sourceFragment": "[{\"text\":\"Your email\"}]",
        "updatedAt": 1714041851000,
        "block": { "id": "q_1", "type": "email-input", "label": "Your email" }
      }
    ],
    "hasMore": false
  }
}

status es missing (nada guardado), current, outdated (el origen cambió desde entonces), o suggested (una sugerencia de IA preparada pero no aceptada). Las claves cubren el contenido del formulario ( block_<id>.) y, una vez que un autor las ha personalizado, los correos de confirmación y recordatorio del respondente (email.confirmation., email.reminder.*).

Establece una entrada de traducción individual. El idioma debe haberse agregado previamente con translations.addLanguage.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{
    "method": "translations.setEntry",
    "params": {
      "formId": "frm_abc123",
      "language": "es",
      "key": "block_q_1.title",
      "value": "[{\"text\":\"Tu correo electrónico\"}]"
    }
  }'

Devuelve { formId, language, key }.

Elimina una entrada de traducción individual, revirtiendo esa clave al idioma predeterminado del formulario. Idempotente. Cuando desaparece la última entrada de un idioma, ese idioma deja de figurar entre los idiomas publicados del formulario.

Obtiene información sobre el usuario autenticado.

{
  "ok": true,
  "data": {
    "id": "usr_abc123",
    "email": "you@example.com",
    "name": "Jane Doe"
  }
}

Lista, ordenados, todos los nombres de métodos que sirve este despliegue. La respuesta autorizada cuando esta página y el servidor no coinciden.

{
  "ok": true,
  "data": {
    "methods": [
      "methods.list",
      "analytics.get",
      "folders.create",
      "folders.delete",
      "folders.list",
      "folders.update",
      "formSettings.get",
      "formSettings.update",
      "forms.create",
      "forms.delete",
      "forms.get",
      "forms.list",
      "..."
    ]
  }
}