API-metoder

List opp skjemaer i en arbeidsområde. Støtter markørpaginering og valgfritt uskarpt navnesøk.

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

Hent fullstendige detaljer for et enkelt skjema, inkludert spørsmål, forsidebilde, logo og en forhåndsvisnings-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..."
  }
}

Opprett et nytt tomt skjema. Returnerer skjemaet og en forhåndsvisnings-URL.

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

Oppdater skjemametadata: navn, mappe, emoji, forsidebilde eller logo. Oppdaterer ikke skjemainnholdet (bruk redigeringsverktøyene for det).

Send minst ett av de fem oppdaterbare feltene. Det endrer ikke skjemainnholdet — bruk MCP-redigeringsverktøyene for det.

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 og logo kommer bare tilbake når du sendte dem. En nyttelast som matchet gjeldende tilstand på hvert skalarfelt legger til noChange: true.

Publiser et skjema slik at det kan motta svar, og fryser feltnøklene i et nytt øyeblikksbilde. Idempotent: et allerede publisert skjema returnerer suksess med alreadyPublished: true, og et upublisert skjema publiseres på nytt fra sitt siste øyeblikksbilde.

Et skjema med innholdsblokker, men ingen spørsmål, publiseres med en advarsel. Et skjema uten noe innhold i det hele tatt kan ikke publiseres. Publisering oppretter ikke en offentlig URL — kall shareLinks.create for det.

Ta et skjema offline. Respondenter kan ikke lenger åpne det. Idempotent — et skjema som ikke er publisert returnerer alreadyUnpublished: true. Reversibelt med forms.publish.

Flytt et skjema til papirkurven. De aktive delingslenkene tilbakekalles, slik at de offentlige URL-ene slutter å fungere.

Gjenopprett et skjema fra papirkurven.

Et skjema som ikke er i papirkurven returnerer alreadyRestored: true.

Les et skjemas atferdsinnstillinger.

Returnerer { settings, isDefault, availableEmailDomains, defaultFromAddress, payment }. isDefault er sann når skjemaet ennå ikke har en lagret innstillingsrad, og du ser standardverdiene. availableEmailDomains inneholder ID-ene til de verifiserte domenene du kan sende som emailDomainId, og payment forteller om Stripe er tilkoblet (å koble det til er et steg i dashbordet).

Oppdater et skjemas atferdsinnstillinger. En delvis oppdatering: bare feltene du sender, skrives.

Emner og meldingstekster er ren tekst og godtar {{variable}}-plassholdere; linjeskift blir avsnitt. Å tilpasse et respondent-emne eller en respondent-melding gjør den oversettbar, så nøklene dukker opp i translations.listEntries med én gang.

List opp et skjemas innsendinger, nyeste side først, med markørpaginering.

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

Hent en lenke til én innsendings PDF. Bygget for Zapier-kobleren: den returnerer et resultat bare når skjemaet har en aktiv Zapier-integrasjon konfigurert til å inkludere PDF-en, og PDF-en ble beholdt.

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

Bygg en syntetisk eksempel-nyttelast for et skjema, uten ekte data. Det er nøyaktig samme form som en webhook-leveranse for en delelenke-innsending bærer, så koblere bruker den til feltoppdagelse; en innsending som stammer fra en forespørsel når i stedet et abonnement som request.completed, samplet av

requests.sample. data.form.snapshotId er skjemaets gjeldende publiserte versjon, samme id som live-hendelser bærer, eller null mens skjemaet er upublisert.

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

Felt- og nyttelastsemantikk er dokumentert ett sted, i webhooks-referansen.

List opp delelenker for et skjema.

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

Opprett en delelenke for et skjema. Skjemaet må være publisert først.

Svaret er delelenken (samme form som et element fra shareLinks.list) pluss availableCustomDomains, slik at du kan følge opp med shareLinks.update for å knytte til ett.

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

Oppdater en delelenke. Du kan endre utløpstidspunkt, maks bruk, egendefinert domene, slug, eller trekke tilbake lenken.

List opp hvert felt i et skjemas nåværende publiserte versjon, med nøkkelen du adresserer det med. Kall denne før requests.create i stedet for å hardkode nøkler. Se Feltnøkler.

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

En gjentakende gruppe er type: “group” med repeating: true og en members-array. En dokumentblokk er type: “documents” og bærer documents: [{ name }], de faste filene enhver respondent allerede ser.

Opprett en forespørsel. Bruker én enhet av arbeidsområdens månedlige kvote, uansett om mottakeren svarer eller ikke.

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 er not_requested til en invitasjon er satt i kø, deretter queued → sent eller failed, og bounced når e-postleverandøren rapporterer en hard retur eller en klage.

Hent én forespørsel i sin helhet: status, utfall, hva som ble forhåndsutfylt, tidslinjen, og — når fullført — answers og display etter feltnøkkel, de samme to kartene callbacken bærer.

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

Eksempelet ovenfor er forkortet. Et fullstendig svar bærer også workspaceId, formSnapshotId, createdVia, documents, reminderStep, remindersSent, reminderDueAt, dataPurgedAt, og resten av tidsstemplene (updatedAt, openedAt, startedAt, lastActivityAt, expiredAt, canceledAt, canceledBy, cancelReason).

To felt forteller deg når kopien foran deg er den eneste kopien. callbackFailedAt er satt mens denne forespørselens callback har gått tom for forsøk, og fjernes så snart ett kommer gjennom eller du spiller det av på nytt. dataPurgedAt settes når oppbevaringspolicyen har fjernet forespørselen: context, prefill og metadata kommer tilbake tomme, readonlyKeys og documents er [], og submissionId, answers og display er null.

timeline er utledet, eldste først. Hver oppføring har en id, en at, og en type — created, invitation, reminder, opened, started, completed, expired, canceled, callback. Leveringsoppføringer legger til deliveryStatus og attemptCount, og callbacks legger til eventType. Leveringsrader beholdes i 30 dager, så eldre tidslinjer tynnes tilbake til tidsstemplene.

List forespørsler i en arbeidsområde eller på ett skjema, nyeste først. Testforespørsler utelates med mindre du ber om dem.

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

Elementer i listen har de samme feltene som requests.get minus url, answers, display, og timeline, og hver har isTest. Oppgi workspaceId eller formId — ingen av dem gir 400 VALIDATION_ERROR med årsak SCOPE_REQUIRED. outcome overstyrer status, siden bare en fullført forespørsel har en avgjørelse.

Trekk tilbake en ventende forespørsel. Lenken slutter å fungere, mottakeren ser en melding om at den er trukket tilbake, og en request.canceled-callback utløses.

Send e-post til mottakeren nå, uten å røre påminnelsesplanen. Krever en mottaker-e-post og en Pro- eller Business-plan.

To grenser gjelder: minst 10 minutter mellom manuelle påminnelser, og maks 8 påminnelser per forespørsel totalt, manuelle og planlagte til sammen. Den automatiske planen røres ikke — reminderStep og reminderDueAt forblir der de var.

Send på nytt callbacken en forespørsel utløste da den avsluttet — samme nyttelast, samme hendelses-ID, slik at en mottaker som allerede håndterte den kan avduplisere. Bruk den etter å ha fikset et ødelagt endepunkt.

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

Bygg en syntetisk eksempel-forespørselshendelse for et skjema, uten noen ekte forespørsel. Det er nøyaktig samme konvolutt et request_*-abonnement opprettet med webhooks.create mottar, så koblere bruker den til feltoppdagelse. En fullført eksempelhendelse bærer de samme eksempelsvarene submissions.sample viser; en utløpt eller kansellert eksempelhendelse bærer bare request-blokken.

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

Request-blokken og utfallet er dokumentert på callbacks-siden; innsendings-halvparten på webhooks-referansen. Eksempel-IDene er de faste plassholderne vist ovenfor, og test er true, slik at en mottaker kan skille et eksempel fra en ekte hendelse.

Reserver en opplasting for en fil du skal gi til én mottaker gjennom skjemaets dokumentblokk. Bytene reiser aldri gjennom dette API-et: du får en forhåndssignert PUT, du laster opp, og requests.create verifiserer objektet før forespørselen finnes.

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

PUT de rå bytene til uploadUrl innen timen, med Content-Type satt til typen du oppga, og referer deretter ID-en fra requests.create:

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

• field er dokumentblokkens feltnøkkel. Valgfri når skjemaet har nøyaktig én blokk; påkrevd med to eller flere.

• Blokkens faste dokumenter blir stående; dine dukker opp under dem, for denne ene mottakeren.
• Grenser: 25 MB per dokument, 100 MB dokumenter per forespørsel, 20 dokumenter vist per blokk inkludert de faste.

• Én opplasting kan refereres av et hvilket som helst antall forespørsler. En opplasting ingen refererer, går ut på dato. Bytene teller mot arbeidsområdeeierens lagring til den siste forespørselen som refererer dem, fjernes av oppbevaringspolicyen.

Enhver feil her er 400 VALIDATION_ERROR med en details.reason: DOCUMENT_TYPE_NOT_ALLOWED, DOCUMENT_TOO_LARGE, INVALID_DOCUMENT_NAME eller INVALID_DOCUMENT_SHA256 fra denne metoden, og DOCUMENT_NOT_FOUND, DOCUMENT_NOT_UPLOADED (du hoppet over PUT), DOCUMENT_INVALID, INVALID_DOCUMENT_TARGET, DOCUMENTS_TOO_LARGE eller DOCUMENTS_TOO_MANY fra requests.create.

List opp webhook-abonnementer for et skjema.

{
  "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 en URL på skjemahendelser: nye eller forlatte innsendinger, eller at en forespørsel på skjemaet avsluttes. URL-en må bruke 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"
  }
}

Abonnementer på forlatte innsendinger returnerer det valgte idleWindow fra både webhooks.create og webhooks.list. Alle andre abonnementer utelater det.

Et forespørsel-abonnement hører de samme hendelsene som en callback gjør, men som sin egen leveranse: sin egen hendelses-ID, sin egen signatur, og sitt eget forsøksbudsjett på fem forsøk, hvoretter abonnementet pauses. En forespørsel opprettet med en callbackUrl på et skjema med et request_completed-abonnement utløses derfor to ganger, én gang til hver mottaker. requests.replayCallback sender bare callbacken på nytt. Bruk requests.sample for å se nyttelasten før noen forespørsel har avsluttet.

Fjern et webhook-abonnement.

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

Hent aggregerte analysemålinger for et skjema. Støtter filtrering på datoperiode, enhet, trafikkilde og land.

Analyser er en Pro-funksjon, og regelen følger planen til eieren av arbeidsområdet, på samme måte som Analyse-fanen i dashbordet. Er ikke eieren på Pro, svarer kallet UPGRADE_REQUIRED — også for historikk som ble registrert mens eieren var det. Et Free-medlem i arbeidsområdet til en Pro-eier får dataene.

Rater er tall fra 0 til 100, antall er heltall, og totalEvents er det rå antallet hendelsesrader før deduplisering til unike besøkende.

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

List opp arbeidsområdeene tokenet ditt kan nå. Ingen parametere.

Et API-token er bundet til én arbeidsområde, så dette returnerer nøyaktig den ene — selv når kontoen din tilhører flere.

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

Opprett en invitasjonslenke til en arbeidsområde.

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

Hent én arbeidsområdeinvitasjon. Returnerer samme form som workspaces.createInvite.

Oppdater en eksisterende arbeidsområdeinvitasjon. Oppgi minst ett av expiresAt eller maxUses, ellers avvises kallet. Returnerer den oppdaterte invitasjonen.

Trekk tilbake en arbeidsområdeinvitasjon permanent.

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

List opp mapper i en arbeidsområde.

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

Opprett en mappe i en arbeidsområde. Idempotent — returnerer den eksisterende mappen hvis en mappe med samme navn allerede finnes.

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

Gi en mappe nytt navn eller flytt den til en annen overordnet mappe.

Slett en mappe og alt innholdet permanent (undermapper og skjemaer).

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

List opp alle språk konfigurert på et skjema.

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

Registrer et språk på et skjema. Enhver annen oversettelsesmetode feiler med 404 NOT_FOUND inntil du gjør det.

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

Fjern et språk og alle dets oversettelser fra et skjema.

List opp hver kildenøkkel for ett språk på et skjema, med gjeldende tilstand. Dette er hvordan du finner key-verdiene translations.setEntry tar.

{
  "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 er missing (ingenting lagret), outdated (kilden endret seg siden), current, eller suggested (et AI-forslag klargjort, men ikke godtatt). Nøkler dekker skjemainnhold (block_<id>.) og, når en forfatter har tilpasset dem, respondentens bekreftelses- og påminnelses-e-poster (email.confirmation., email.reminder.*).

Angi en enkelt oversettelsespost. Språket må ha blitt lagt til via translations.addLanguage først.

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

Returnerer { formId, language, key }.

Slett en enkelt oversettelsespost, som tilbakestiller den nøkkelen til skjemaets standardspråk. Idempotent. Når den siste posten for et språk forsvinner, faller språket ut av skjemaets publiserte språk.

Hent informasjon om den autentiserte brukeren.

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

List opp alle metodenavn dette driftsmiljøet betjener, sortert. Det autoritative svaret når denne siden og serveren er uenige.

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