API-methoden

Geeft een lijst van formulieren in een workspace. Ondersteunt cursorpaginering en optioneel fuzzy zoeken op naam.

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

Haalt volledige details op van een enkel formulier, inclusief vragen, omslag, logo en een voorbeeld-URL.

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

Maak een nieuw leeg formulier aan. Geeft het formulier en een voorbeeld-URL terug.

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

Werk formuliermetadata bij: naam, map, emoji, omslag of logo. Werkt de formulierinhoud niet bij (gebruik daarvoor de editor-tools).

Geef minstens één van de vijf bij te werken velden mee. Dit wijzigt de formulierinhoud niet — gebruik daarvoor de MCP-editor-tools.

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 en logo komen alleen terug wanneer je ze hebt meegestuurd. Een payload die op elk scalair veld al overeenkwam met de huidige staat voegt noChange: true toe.

Publiceer een formulier zodat het reacties kan ontvangen, en bevries de veldsleutels ervan in een nieuwe snapshot. Idempotent: een al gepubliceerd formulier geeft succes terug met alreadyPublished: true, en een gedepubliceerd formulier wordt opnieuw gepubliceerd vanaf zijn laatste snapshot.

Een formulier met inhoudsblokken maar geen vragen publiceert met een waarschuwing. Een formulier zonder enige inhoud kan niet worden gepubliceerd. Publiceren maakt geen openbare URL aan — roep daarvoor shareLinks.create aan.

Haal een formulier offline. Respondenten kunnen het niet meer openen. Idempotent — een formulier dat niet is gepubliceerd geeft alreadyUnpublished: true terug. Omkeerbaar met forms.publish.

Verplaats een formulier naar de prullenbak. De actieve deellinks ervan worden ingetrokken, zodat hun openbare URL’s stoppen met werken.

Herstel een formulier uit de prullenbak.

Een formulier dat niet in de prullenbak zit geeft alreadyRestored: true terug.

Lees de gedragsinstellingen van een formulier.

Geeft { settings, isDefault, availableEmailDomains, defaultFromAddress, payment } terug. isDefault is true wanneer het formulier nog geen opgeslagen instellingenrij heeft en je de standaardwaarden ziet. availableEmailDomains bevat de geverifieerde domein-ids die je kunt meegeven als emailDomainId, en payment meldt of Stripe is gekoppeld (koppelen is een stap in het dashboard).

Werk de gedragsinstellingen van een formulier bij. Een gedeeltelijke update: alleen de velden die je meestuurt worden geschreven.

Onderwerpen en teksten zijn platte tekst en accepteren {{variable}}-plaatshouders; nieuwe regels worden alinea’s. Een onderwerp of tekst voor respondenten aanpassen maakt het vertaalbaar, dus de sleutels ervan verschijnen meteen in translations.listEntries.

Geeft de inzendingen van een formulier weer, nieuwste pagina eerst, met cursorpaginering.

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

Haal een link op naar de PDF van één inzending. Gebouwd voor de Zapier-connector: het geeft alleen een resultaat terug wanneer het formulier een actieve Zapier-integratie heeft die is ingesteld om de PDF mee te sturen, en de PDF is bewaard.

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

Bouw een voorbeeld-inzendingspayload voor een formulier, zonder echte data. Het is precies de vorm die een levering van een inzending via een openbare link draagt, dus connectors gebruiken het voor velddetectie; een inzending die uit een aanvraag voortkomt, bereikt een abonnement in plaats daarvan als request.completed, en die bouw je met requests.sample.

data.form.snapshotId is de huidige gepubliceerde versie van het formulier, hetzelfde id dat live events dragen, of null zolang het formulier ongepubliceerd is.

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

Veld- en payloadsemantiek staan één keer gedocumenteerd: de webhooks-referentie beschrijft ze.

Geeft een lijst van deellinks voor een formulier.

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

Maak een deellink aan voor een formulier. Het formulier moet eerst gepubliceerd zijn.

De response is de deellink (dezelfde vorm als een item van shareLinks.list) plus availableCustomDomains, zodat je kunt vervolgen met shareLinks.update om er een te koppelen.

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

Werk een deellink bij. Je kunt de vervaldatum, het maximum aantal claims, het aangepaste domein, de slug wijzigen of de link intrekken.

Geef elk veld van de huidige gepubliceerde versie van een formulier terug, met de sleutel om het aan te spreken. Roep dit aan vóór requests.create in plaats van sleutels hard te coderen. Zie Veldsleutels.

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

Een herhalende groep is type: “group” met repeating: true en een members-array. Een Documentenblok is type: “documents” en draagt documents: [{ name }], de aangeleverde bestanden die elke respondent al ziet.

Maak een aanvraag aan. Verbruikt één eenheid van het maandelijkse quotum van de werkruimte, of de ontvanger nu antwoordt of niet.

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 is not_requested tot een uitnodiging in de wachtrij staat, dan queued → sent of failed, en bounced zodra de mailprovider een harde bounce of een klacht meldt.

Haal één aanvraag volledig op: status, uitkomst, wat er vooraf is ingevuld, zijn tijdlijn, en — zodra voltooid — answers en display gesorteerd op veldsleutel, dezelfde twee kaarten die de callback draagt.

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

Het bovenstaande voorbeeld is ingekort. Een volledige response draagt ook workspaceId, formSnapshotId, createdVia, documents, reminderStep, remindersSent, reminderDueAt, dataPurgedAt, en de rest van de tijdstempels (updatedAt, openedAt, startedAt, lastActivityAt, expiredAt, canceledAt, canceledBy, cancelReason).

Twee velden vertellen je wanneer de kopie voor je neus de enige kopie is. callbackFailedAt is ingesteld terwijl de callback van deze aanvraag geen pogingen meer over heeft, en wordt gewist zodra er één doorkomt of je hem opnieuw afspeelt. dataPurgedAt is ingesteld zodra bewaarbeleid de aanvraag heeft gestript: context, prefill en metadata komen leeg terug, readonlyKeys en documents zijn [], en submissionId, answers en display zijn null.

timeline is afgeleid, oudste eerst. Elk item heeft een id, een at, en een type — created, invitation, reminder, opened, started, completed, expired, canceled, callback. Bezorgitems voegen deliveryStatus en attemptCount toe, en callbacks voegen eventType toe. Bezorgrijen worden 30 dagen bewaard, dus oudere tijdlijnen dunnen uit tot de tijdstempels.

Geef aanvragen in een werkruimte of van één formulier terug, nieuwste eerst. Testaanvragen worden weggelaten tenzij je erom vraagt.

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

Items in de lijst dragen dezelfde velden als requests.get minus url, answers, display, en timeline, en elk item draagt isTest. Geef workspaceId of formId mee — geen van beide geeft 400 VALIDATION_ERROR met reden SCOPE_REQUIRED. outcome overschrijft status omdat alleen een voltooide aanvraag een oordeel heeft.

Trek een aanvraag in behandeling in. De link stopt met werken, de ontvanger ziet een intrekkingsmelding, en er vuurt een request.canceled-callback af.

Mail de ontvanger nu, zonder het herinneringsschema aan te raken. Vereist een e-mailadres van de ontvanger en een Pro- of Business-abonnement.

Er gelden twee ondergrenzen: minstens 10 minuten tussen handmatige herinneringen, en maximaal 8 herinneringen per aanvraag in totaal, handmatig en gepland samen. Het automatische schema blijft ongemoeid — reminderStep en reminderDueAt blijven zoals ze waren.

Stuur de callback die een aanvraag afvuurde bij het eindigen opnieuw — dezelfde payload, hetzelfde gebeurtenis-id, zodat een ontvanger die hem al verwerkte kan dedupliceren. Gebruik dit nadat je een kapot endpoint hebt gerepareerd.

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

Bouw een voorbeeld van een aanvraag-event voor een formulier, zonder een echte aanvraag. Het is precies de envelop die een

request_*-abonnement, aangemaakt met webhooks.create, ontvangt, dus connectors gebruiken het voor velddetectie. Een voltooid voorbeeld draagt dezelfde voorbeeldantwoorden die submissions.sample toont; een verlopen of geannuleerd voorbeeld draagt alleen het aanvraagblok.

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

Het aanvraagblok en de uitkomst staan gedocumenteerd op de pagina Callbacks; de inzendingshelft op de webhooks-referentie. Voorbeeld-ids zijn de vaste placeholders die hierboven getoond worden en test is true, zodat een ontvanger een voorbeeld van een live event kan onderscheiden.

Reserveer een upload voor een bestand dat je aan één ontvanger geeft via het Documentenblok van het formulier. Bytes reizen nooit via deze API: je krijgt een presigned PUT, je uploadt, en requests.create verifieert het object voordat de aanvraag bestaat.

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

PUT de ruwe bytes naar uploadUrl binnen het uur, met Content-Type ingesteld op het type dat je hebt opgegeven, en verwijs dan naar het id vanuit requests.create:

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

• field is de veldsleutel van het Documentenblok. Optioneel wanneer het formulier precies één blok heeft; verplicht bij twee of meer.

• De aangeleverde documenten van het blok blijven staan; die van jou verschijnen eronder, alleen voor deze ene ontvanger.
• Limieten: 25 MB per document, 100 MB aan documenten per aanvraag, 20 documenten getoond per blok inclusief de aangeleverde.

• Eén upload kan door elk aantal aanvragen worden gerefereerd. Een upload waarnaar niemand verwijst, vervalt na verloop van tijd. Bytes tellen mee voor de opslag van de werkruimte-eigenaar totdat de laatste aanvraag die ernaar verwijst door bewaarbeleid wordt gestript.

Elke fout hier is 400 VALIDATION_ERROR met een details.reason: DOCUMENT_TYPE_NOT_ALLOWED, DOCUMENT_TOO_LARGE, INVALID_DOCUMENT_NAME of INVALID_DOCUMENT_SHA256 van deze methode, en DOCUMENT_NOT_FOUND, DOCUMENT_NOT_UPLOADED (je hebt de PUT overgeslagen), DOCUMENT_INVALID, INVALID_DOCUMENT_TARGET, DOCUMENTS_TOO_LARGE of DOCUMENTS_TOO_MANY van requests.create.

Geeft een lijst van webhook-abonnementen voor een formulier.

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

Abonneer een URL op formuliergebeurtenissen: nieuwe of verlaten inzendingen, of aanvragen op het formulier die eindigen. De URL moet HTTPS gebruiken.

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

Abonnementen op verlaten inzendingen geven de gekozen idleWindow terug, zowel van webhooks.create als van webhooks.list. Elk ander abonnement laat dit weg.

Een aanvraagabonnement ontvangt dezelfde events als een callback, maar als een eigen levering: een eigen event-id, een eigen handtekening, en een eigen budget van vijf pogingen, waarna het abonnement pauzeert. Een aanvraag die aangemaakt is met een callbackUrl op een formulier met een request_completed-abonnement vuurt daarom twee keer af, één keer naar elke ontvanger. requests.replayCallback stuurt alleen de callback opnieuw. Gebruik requests.sample om de payload te zien voordat er een aanvraag is geëindigd.

Verwijder een webhook-abonnement.

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

Haal geaggregeerde analysecijfers op voor een formulier. Ondersteunt filters op datumbereik, apparaat, verkeersbron en land.

Analyses zijn een Pro-functie, en de regel volgt het abonnement van de eigenaar van de workspace, net als het tabblad Analyses in het dashboard. Heeft de eigenaar geen Pro, dan geeft de aanroep UPGRADE_REQUIRED terug — ook voor geschiedenis die is vastgelegd toen dat wel zo was. Een Free-lid in de workspace van een Pro-eigenaar krijgt de gegevens wel.

Percentages zijn getallen van 0 tot 100, aantallen zijn gehele getallen, en totalEvents is het aantal ruwe gebeurtenisrijen vóór deduplicatie naar unieke bezoekers.

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

Geeft de workspaces weer die jouw token kan bereiken. Geen parameters.

Een API-token is gebonden aan één workspace, dus dit geeft precies die ene terug — ook als je account tot meerdere behoort.

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

Maak een uitnodigingslink aan voor een workspace.

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

Haal één workspace-uitnodiging op. Geeft dezelfde vorm terug als workspaces.createInvite.

Werk een bestaande workspace-uitnodiging bij. Geef minstens expiresAt of maxUses mee, anders wordt de aanroep geweigerd. Geeft de bijgewerkte uitnodiging terug.

Trek een workspace-uitnodiging permanent in.

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

Geeft een lijst van mappen in een workspace.

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

Maak een map aan in een workspace. Idempotent — geeft de bestaande map terug als er al een map met dezelfde naam bestaat.

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

Hernoem een map of verplaats hem naar een andere bovenliggende map.

Verwijder een map en alle inhoud permanent (submappen en formulieren).

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

Geeft een lijst van alle talen die zijn geconfigureerd op een formulier.

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

Registreer een taal op een formulier. Elke andere vertaalmethode faalt met 404 NOT_FOUND totdat je dit doet.

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

Verwijder een taal en alle bijbehorende vertalingen van een formulier.

Geeft elke bronsleutel voor één taal op een formulier weer, met zijn huidige status. Zo ontdek je de key-waarden die translations.setEntry verwacht.

{
  "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 is missing (niets opgeslagen), outdated (de bron is sindsdien gewijzigd), current, of suggested (een AI-suggestie klaargezet maar niet geaccepteerd). Sleutels dekken formulierinhoud ( block_<id>.) en, zodra een auteur ze heeft aangepast, de bevestigings- en herinnerings-e-mails voor de respondent ( email.confirmation., email.reminder.*).

Stel een enkel vertaalitem in. De taal moet eerst zijn toegevoegd via 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\"}]"
    }
  }'

Geeft { formId, language, key } terug.

Verwijder een enkel vertaalitem, waardoor die sleutel terugvalt op de standaardtaal van het formulier. Idempotent. Verdwijnt het laatste item voor een taal, dan verdwijnt die taal uit de gepubliceerde talen van het formulier.

Haal informatie op over de ingelogde gebruiker.

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

Geeft elke methodenaam weer die deze deployment aanbiedt, gesorteerd. Het gezaghebbende antwoord wanneer deze pagina en de server niet overeenkomen.

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