Méthodes API

Lister les formulaires d’un espace de travail. Prend en charge la pagination par curseur et une recherche par nom approximative.

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
  }
}

Obtenir tous les détails d’un formulaire, notamment les questions, la couverture, le logo et une URL de prévisualisation.

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..."
  }
}

Créer un nouveau formulaire vide. Retourne le formulaire et une URL de prévisualisation.

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..."
  }
}

Mettre à jour les métadonnées d’un formulaire : nom, dossier, emoji, couverture ou logo. Ne modifie pas le contenu du formulaire (utilisez les outils d’édition pour cela).

Passez au moins un des cinq champs modifiables. Cela ne change pas le contenu du formulaire — utilisez les outils MCP d’édition pour cela.

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 et logo ne reviennent que si vous les avez envoyés. Un payload identique à l’état actuel sur chaque champ scalaire ajoute noChange: true.

Publier un formulaire pour qu’il puisse accepter des réponses, et figer ses clés de champ dans un nouveau snapshot. Idempotent : un formulaire déjà publié renvoie un succès avec alreadyPublished: true, et un formulaire dépublié est republié depuis son dernier snapshot.

Un formulaire avec des blocs de contenu mais sans question se publie avec un avertissement. Un formulaire sans aucun contenu ne peut pas être publié. Publier ne crée pas d’URL publique — appelez shareLinks.create pour cela.

Mettre un formulaire hors ligne. Les répondants ne peuvent plus l’ouvrir. Idempotent — un formulaire non publié renvoie alreadyUnpublished: true. Réversible avec forms.publish.

Déplacer un formulaire vers la corbeille. Ses liens de partage actifs sont révoqués, donc leurs URLs publiques cessent de fonctionner.

Restaurer un formulaire depuis la corbeille.

Un formulaire qui n’est pas dans la corbeille renvoie alreadyRestored: true.

Lire les paramètres de comportement d’un formulaire.

Renvoie { settings, isDefault, availableEmailDomains, defaultFromAddress, payment }. isDefault vaut vrai quand le formulaire n’a pas encore de ligne de paramètres enregistrée et que vous voyez les valeurs par défaut. availableEmailDomains contient les ids de domaines vérifiés à passer comme emailDomainId, et payment indique si Stripe est connecté (le connecter est une étape du tableau de bord).

Mettre à jour les paramètres de comportement d’un formulaire. Une mise à jour partielle : seuls les champs envoyés sont écrits.

Les objets et corps sont du texte brut et acceptent les paramètres {{variable}} ; les sauts de ligne deviennent des paragraphes. Personnaliser un objet ou un corps destiné au répondant le rend traduisible, donc ses clés apparaissent immédiatement dans translations.listEntries.

Lister les soumissions d’un formulaire, page la plus récente en premier, avec pagination par curseur.

{
  "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
  }
}

Obtenir un lien vers le PDF d’une soumission. Conçu pour le connecteur Zapier : renvoie un résultat seulement quand le formulaire a une intégration Zapier active configurée pour inclure le PDF, et que le PDF a été conservé.

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

Construire un payload de soumission d’exemple pour un formulaire, sans aucune donnée réelle. C’est exactement la forme que porte une livraison de soumission sur lien public, donc les connecteurs s’en servent pour découvrir les champs ; une soumission provenant d’une demande atteint un abonnement sous forme de request.completed à la place, échantillonnée par

requests.sample. data.form.snapshotId est la version publiée actuelle du formulaire, le même id que portent les événements en direct, ou null tant que le formulaire n’est pas publié.

{
  "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 sémantique des champs et du payload est documentée une seule fois, dans la référence webhooks.

Lister les liens de partage d’un formulaire.

{
  "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
  }
}

Créer un lien de partage pour un formulaire. Le formulaire doit d’abord être publié.

La réponse est le lien de partage (même forme qu’un élément de shareLinks.list) plus availableCustomDomains, pour que vous puissiez enchaîner avec shareLinks.update et en associer un.

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
    }
  }'

Mettre à jour un lien de partage. Permet de modifier l’expiration, le nombre maximum d’utilisations, le domaine personnalisé, le slug, ou de révoquer le lien.

Liste chaque champ de la version actuellement publiée d’un formulaire, avec la clé pour l’adresser. Appelez ceci avant requests.create au lieu de coder les clés en dur. Voir Clés de champ.

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 groupe répétable est type: “group” avec repeating: true et un tableau members. Un bloc Documents est type: “documents” et porte documents: [{ name }], les fichiers déjà rédigés que chaque répondant voit déjà.

Crée une demande. Consomme une unité de l’allocation mensuelle de l’espace de travail, que le destinataire réponde ou non.

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 vaut not_requested jusqu’à ce qu’une invitation soit mise en file, puis queued → sent ou failed, et bounced une fois que le fournisseur d’e-mail signale un rejet définitif ou une plainte.

Récupère une demande en entier : statut, résultat, ce qui a été prérempli, sa chronologie, et — une fois terminée — answers et display classées par clé de champ, les deux mêmes maps que porte le 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
  }
}

L’exemple ci-dessus est réduit. Une réponse complète porte aussi workspaceId, formSnapshotId, createdVia, documents, reminderStep, remindersSent, reminderDueAt, dataPurgedAt, et le reste des horodatages (updatedAt, openedAt, startedAt, lastActivityAt, expiredAt, canceledAt, canceledBy, cancelReason).

Deux champs indiquent quand la copie sous vos yeux est la seule copie. callbackFailedAt est défini tant que le callback de cette demande a épuisé ses tentatives, et effacé une fois qu’un passe ou que vous le rejouez. dataPurgedAt est défini une fois que la rétention a dépouillé la demande : context, prefill et metadata reviennent vides, readonlyKeys et documents valent [], et submissionId, answers et display valent null.

timeline est dérivée, du plus ancien au plus récent. Chaque entrée a un id, un at, et un type — created, invitation, reminder, opened, started, completed, expired, canceled, callback. Les entrées de livraison ajoutent deliveryStatus et attemptCount, et les callbacks ajoutent eventType. Les lignes de livraison sont conservées 30 jours, donc les chronologies plus anciennes s’amincissent jusqu’aux horodatages.

Liste les demandes d’un espace de travail ou d’un formulaire, les plus récentes en premier. Les demandes de test sont exclues sauf si vous les demandez.

{
  "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
  }
}

Les éléments de la liste portent les mêmes champs que requests.get moins url, answers, display, et timeline, et chacun porte isTest. Fournissez workspaceId ou formId — n’en fournir aucun renvoie 400 VALIDATION_ERROR avec la raison SCOPE_REQUIRED. outcome prime sur status, puisque seule une demande terminée a un verdict.

Retire une demande en attente. Le lien cesse de fonctionner, le destinataire voit un avis de retrait, et un callback request.canceled se déclenche.

Envoie un e-mail au destinataire maintenant, sans toucher au planning de rappel. Nécessite un e-mail de destinataire et un plan Pro ou Business.

Deux planchers s’appliquent : au moins 10 minutes entre deux rappels manuels, et 8 rappels au maximum par demande au total, manuels et programmés confondus. Le planning automatique n’est pas touché — reminderStep et reminderDueAt restent où ils étaient.

Renvoie le callback qu’une demande a déclenché à sa fin — même charge utile, même id d’événement, pour qu’un récepteur qui l’a déjà traité puisse dédupliquer. À utiliser après avoir réparé un point de terminaison défaillant.

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

Construire un événement de demande d’exemple pour un formulaire, sans aucune demande réelle. C’est exactement l’enveloppe que reçoit un abonnement request_* créé avec webhooks.create, donc les connecteurs s’en servent pour découvrir les champs. Un exemple terminé porte les mêmes réponses d’exemple que montre

submissions.sample ; un exemple expiré ou annulé porte seulement le bloc 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" }
    }
  }
}

Le bloc request et le résultat sont documentés sur la page des callbacks ; le volet soumission, sur la référence webhooks. Les ids d’exemple sont les valeurs fixes indiquées ci-dessus et test vaut true, afin qu’un récepteur puisse distinguer un exemple d’un événement réel.

Réserver un téléversement pour un fichier que vous remettrez à un destinataire via le bloc Documents du formulaire. Les octets ne transitent jamais par cette API : vous obtenez un PUT présigné, vous téléversez, et requests.create vérifie l’objet avant que la demande n’existe.

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

Faites un PUT des octets bruts vers uploadUrl dans l’heure, avec Content-Type réglé sur le type déclaré, puis référencez l’id depuis requests.create :

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

• field est la clé de champ du bloc Documents. Optionnelle quand le formulaire a exactement un bloc ; requise avec deux ou plus.

• Les documents rédigés du bloc restent ; les vôtres apparaissent en dessous, pour ce seul destinataire.
• Plafonds : 25 Mo par document, 100 Mo de documents par demande, 20 documents affichés par bloc, documents rédigés compris.

• Un téléversement peut être référencé par un nombre quelconque de demandes. Un téléversement que rien ne référence expire. Les octets comptent dans le stockage du propriétaire de l’espace de travail jusqu’à ce que la dernière demande qui les référence soit dépouillée par la rétention.

Chaque échec ici est 400 VALIDATION_ERROR avec un details.reason : DOCUMENT_TYPE_NOT_ALLOWED, DOCUMENT_TOO_LARGE, INVALID_DOCUMENT_NAME ou INVALID_DOCUMENT_SHA256 pour cette méthode, et DOCUMENT_NOT_FOUND, DOCUMENT_NOT_UPLOADED (vous avez sauté le PUT), DOCUMENT_INVALID, INVALID_DOCUMENT_TARGET, DOCUMENTS_TOO_LARGE ou DOCUMENTS_TOO_MANY pour requests.create.

Lister les abonnements webhook d’un formulaire.

{
  "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
  }
}

Abonner une URL aux événements d’un formulaire : soumissions nouvelles ou abandonnées, ou demandes du formulaire qui se terminent. L’URL doit utiliser 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"
  }
}

Les abonnements de soumission abandonnée renvoient l’idleWindow choisi, à la fois depuis webhooks.create et webhooks.list. Tout autre abonnement l’omet.

Un abonnement de demande entend les mêmes événements qu’un callback, mais comme sa propre livraison : son propre id d’événement, sa propre signature, et son propre budget de cinq tentatives, après quoi l’abonnement se met en pause. Une demande créée avec un callbackUrl sur un formulaire ayant un abonnement request_completed se déclenche donc deux fois, une fois vers chaque récepteur. requests.replayCallback ne renvoie que le callback. Utilisez requests.sample pour voir le payload avant qu’une demande ne se soit terminée.

Supprimer un abonnement webhook.

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

Obtenir les métriques analytiques agrégées d’un formulaire. Prend en charge les filtres par plage de dates, appareil, source de trafic et pays.

Les analyses sont une fonctionnalité Pro, et la règle suit le forfait du propriétaire de l’espace de travail, comme l’onglet Analyses du tableau de bord. Si le propriétaire n’est pas sur Pro, l’appel renvoie UPGRADE_REQUIRED — y compris pour l’historique enregistré quand il l’était. Un membre Free dans l’espace d’un propriétaire Pro reçoit bien les données.

Les taux sont des nombres de 0 à 100, les compteurs sont des entiers, et totalEvents est le nombre brut de lignes d’événements avant déduplication en visiteurs uniques.

{
  "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 }
    }
  }
}

Lister les espaces de travail que votre token peut atteindre. Aucun paramètre.

Un token API est lié à un seul espace de travail, donc ceci renvoie exactement celui-là — même quand votre compte appartient à plusieurs.

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

Créer un lien d’invitation pour un espace de travail.

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

Obtenir une invitation à un espace de travail. Renvoie la même forme que workspaces.createInvite.

Mettre à jour une invitation existante à un espace de travail. Fournissez au moins l’un des champs expiresAt ou

maxUses, sinon l’appel est rejeté. Renvoie l’invitation mise à jour.

Révoquer définitivement une invitation à un espace de travail.

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

Lister les dossiers d’un espace de travail.

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

Créer un dossier dans un espace de travail. Idempotent — retourne le dossier existant si un dossier portant le même nom existe déjà.

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

Renommer un dossier ou le déplacer dans un autre parent.

Supprimer définitivement un dossier et tout son contenu (sous-dossiers et formulaires).

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

Lister toutes les langues configurées sur un formulaire.

{
  "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
  }
}

Enregistrer une langue sur un formulaire. Toute autre méthode de traduction échoue avec 404 NOT_FOUND tant que ce n’est pas fait.

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

Supprimer une langue et toutes ses traductions d’un formulaire.

Lister chaque clé source pour une langue sur un formulaire, avec son état actuel. C’est ainsi que vous découvrez les valeurs de key que prend 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 vaut missing (rien de stocké), outdated (la source a changé depuis), current, ou suggested (une suggestion IA en attente, non acceptée). Les clés couvrent le contenu du formulaire ( block_<id>.) et, une fois qu’un auteur les a personnalisés, les e-mails de confirmation et de rappel au répondant ( email.confirmation., email.reminder.*).

Définir une entrée de traduction. La langue doit avoir été ajoutée via translations.addLanguage au préalable.

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\"}]"
    }
  }'

Renvoie { formId, language, key }.

Supprimer une entrée de traduction, ce qui fait revenir cette clé à la langue par défaut du formulaire. Idempotent. Quand la dernière entrée d’une langue disparaît, la langue quitte les langues publiées du formulaire.

Obtenir des informations sur l’utilisateur authentifié.

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

Lister chaque nom de méthode que ce déploiement sert, trié. La réponse qui fait foi quand cette page et le serveur ne sont pas d’accord.

{
  "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",
      "..."
    ]
  }
}