API metodları

Bir çalışma alanındaki formları listeler. İmleç tabanlı sayfalama ve isteğe bağlı bulanık ad aramasını destekler.

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

Tek bir form için sorular, kapak, logo ve önizleme URL’si dahil tüm ayrıntıları getirir.

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

Yeni bir boş form oluşturur. Formu ve bir önizleme URL’sini döndürür.

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

Form meta verilerini günceller: ad, klasör, emoji, kapak veya logo. Form içeriğini güncellemez (bunun için editör araçlarını kullanın).

Güncellenebilir beş alandan en az birini gönderin. Form içeriğini değiştirmez — bunun için MCP editör araçlarını kullanın.

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 ve logo yalnızca siz gönderdiğinizde geri döner. Skaler her alanda geçerli durumla eşleşen bir istek gövdesi noChange: true ekler.

Bir formu yanıt kabul edebilmesi için yayınlar ve alan anahtarlarını yeni bir anlık görüntüye dondurur. Idempotent: zaten yayınlanmış bir form alreadyPublished: true ile başarı döner, yayından kaldırılmış bir form ise son anlık görüntüsünden yeniden yayınlanır.

İçerik blokları olan ama sorusu olmayan bir form bir uyarıyla birlikte yayınlanır. Hiç içeriği olmayan bir form yayınlanamaz. Yayınlamak genel bir URL oluşturmaz — bunun için shareLinks.create’i çağırın.

Bir formu çevrimdışı yapar. Yanıtlayıcılar artık onu açamaz. Idempotent — yayınlanmamış bir form alreadyUnpublished: true döner. forms.publish ile geri alınabilir.

Bir formu çöp kutusuna taşır. Etkin paylaşım bağlantıları iptal edilir, böylece genel URL’leri hizmet vermeyi durdurur.

Bir formu çöp kutusundan geri yükler.

Çöp kutusunda olmayan bir form alreadyRestored: true döner.

Bir formun davranış ayarlarını okur.

{ settings, isDefault, availableEmailDomains, defaultFromAddress, payment } döner. Form henüz kaydedilmiş bir ayar satırına sahip değilse ve varsayılanları görüyorsanız isDefault true olur. availableEmailDomains, emailDomainId olarak geçirebileceğiniz doğrulanmış alan adı kimliklerini tutar, payment ise Stripe’ın bağlı olup olmadığını bildirir (bağlamak bir kontrol paneli adımıdır).

Bir formun davranış ayarlarını günceller. Kısmi bir güncelleme: yalnızca gönderdiğiniz alanlar yazılır.

Konular ve gövdeler düz metindir ve {{variable}} yer tutucularını kabul eder; yeni satırlar paragraf olur. Bir yanıtlayıcı konusunu veya gövdesini özelleştirmek onu çevrilebilir kılar, böylece anahtarları hemen translations.listEntries ’te görünür.

Bir formun gönderimlerini, en yeni sayfa önce olacak şekilde imleç tabanlı sayfalamayla listeler.

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

Bir gönderimin PDF’sine bir bağlantı getirir. Zapier bağlayıcısı için oluşturulmuştur: yalnızca formda PDF’i dahil edecek şekilde yapılandırılmış etkin bir Zapier entegrasyonu varsa ve PDF saklandıysa bir sonuç döner.

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

Bir form için gerçek veri olmadan örnek bir gönderim yükü oluşturur. Bu, bir genel bağlantı gönderimi teslimatının taşıdığı tam biçimdir, bu yüzden bağlayıcılar onu alan keşfi için kullanır; bir istekten doğan bir gönderim ise bir aboneliğe bunun yerine request.completed olarak ulaşır, bu da

requests.sample’ın örneklediği şeydir. data.form.snapshotId, formun güncel yayımlanmış sürümüdür, canlı olayların taşıdığı aynı kimliktir; form yayımlanmamışken ise null’dur.

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

Alan ve yük anlambilimi tek bir yerde, webhooks referansında belgelenmiştir.

Bir formun paylaşım bağlantılarını listeler.

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

Bir form için paylaşım bağlantısı oluşturur. Formun önce yayınlanmış olması gerekir.

Yanıt, paylaşım bağlantısıdır (bir shareLinks.list öğesiyle aynı biçimde) artı availableCustomDomains, böylece bir tane eklemek için shareLinks.update ile devam edebilirsiniz.

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

Bir paylaşım bağlantısını günceller. Son kullanma tarihi, maksimum talep sayısı, özel alan adı, slug değiştirilebilir ya da bağlantı iptal edilebilir.

Bir formun geçerli yayınlanmış sürümündeki her alanı, her birini adreslemek için kullanılacak anahtarla birlikte listeler. Anahtarları koda gömmek yerine bunu requests.create’ten önce çağırın. Bkz. Alan anahtarları.

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

Tekrarlanan bir grup, repeating: true ve bir members dizisiyle birlikte type: “group”’dur. Bir Belgeler bloğu type: “documents”’tir ve her yanıtlayıcının zaten gördüğü, yazarın eklediği dosyaları taşıyan documents: [{ name }]’i içerir.

Bir istek oluşturur. Alıcı yanıtlasın ya da yanıtlamasın, çalışma alanının aylık kotasından bir birim harcar.

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, bir davet kuyruğa alınana kadar not_requested’tır, ardından queued → sent ya da failed olur, ve posta sağlayıcısı bir sert geri dönüş veya şikayet bildirdiğinde bounced olur.

Bir isteği tam olarak alın: durum, sonuç, önceden doldurulan değerler, zaman çizelgesi ve — tamamlandıysa — geri çağırmanın taşıdığıyla aynı iki eşleme olan, alan anahtarına göre anahtarlanmış answers ve display.

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

Yukarıdaki örnek kısaltılmıştır. Tam bir yanıt ayrıca workspaceId, formSnapshotId, createdVia, documents, reminderStep, remindersSent, reminderDueAt, dataPurgedAt ve zaman damgalarının geri kalanını taşır (updatedAt, openedAt, startedAt, lastActivityAt ile expiredAt, canceledAt, canceledBy, cancelReason).

İki alan, önünüzdeki kopyanın tek kopya olduğu anı söyler. callbackFailedAt, bu isteğin geri çağırması denemelerini tükettiğinde ayarlanır ve biri başarılı olduğunda ya da onu yeniden oynattığınızda temizlenir. dataPurgedAt, saklama süresi isteği ayıkladığında ayarlanır: context, prefill ve metadata boş döner, readonlyKeys ve documents [] olur, submissionId, answers ve display ise null olur.

timeline türetilmiştir, en eskiden en yeniye sıralıdır. Her girişin bir id’si, bir at’ı ve bir type’ı vardır — created, invitation, reminder, opened, started, completed, expired, canceled, callback. Teslimat girişleri deliveryStatus ve attemptCount ekler, geri çağırmalar ise eventType ekler. Teslimat satırları 30 gün tutulur, bu yüzden daha eski zaman çizelgeleri yalnızca zaman damgalarına indirgenir.

Bir çalışma alanındaki veya bir formdaki istekleri en yeniden en eskiye listeler. Test istekleri, siz istemedikçe dışarıda bırakılır.

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

Liste öğeleri, url, answers, display ve timeline hariç requests.get ile aynı alanları taşır ve her biri isTest taşır. workspaceId ya da formId verin — hiçbirini vermemek, nedeni SCOPE_REQUIRED olan bir 400 VALIDATION_ERROR döner. outcome, status’u geçersiz kılar, çünkü yalnızca tamamlanmış bir isteğin bir kararı vardır.

Beklemedeki bir isteği geri çeker. Bağlantı çalışmayı durdurur, alıcı bir geri çekilme bildirimi görür ve bir request.canceled geri çağırması tetiklenir.

Hatırlatma programına dokunmadan alıcıya şimdi e-posta gönderir. Bir alıcı e-postası ve Pro veya Business plan gerektirir.

İki sınır uygulanır: manuel hatırlatmalar arasında en az 10 dakika, ve istek başına toplamda — manuel ve zamanlanmış birlikte — en fazla 8 hatırlatma. Otomatik program dokunulmamış kalır — reminderStep ve reminderDueAt oldukları yerde kalır.

Bir isteğin sona erdiğinde tetiklediği geri çağırmayı yeniden gönderir — aynı yük, aynı olay kimliği, böylece onu zaten işleyen bir alıcı tekilleştirebilir. Bozuk bir uç noktayı düzelttikten sonra kullanın.

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

Bir form için gerçek bir istek olmadan örnek bir istek olayı oluşturur. Bu, webhooks.create ile oluşturulmuş bir request_* aboneliğinin aldığı tam zarftır, bu yüzden bağlayıcılar onu alan keşfi için kullanır. Tamamlanmış bir örnek,

submissions.sample’ın gösterdiği aynı örnek yanıtları taşır; süresi dolmuş veya iptal edilmiş bir örnek ise yalnızca istek bloğunu taşır.

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

İstek bloğu ve outcome, geri çağırmalar sayfasında belgelenmiştir; gönderim yarısı ise webhook referansında. Örnek kimlikler yukarıda gösterilen sabit yer tutuculardır ve test, true’dur, bu yüzden bir alıcı bir örneği canlı bir olaydan ayırt edebilir.

Formun Belgeler bloğu aracılığıyla bir alıcıya vereceğiniz bir dosya için bir yükleme ayırır. Baytlar hiçbir zaman bu API’den geçmez: önceden imzalanmış bir PUT alırsınız, yüklersiniz ve requests.create, istek var olmadan önce nesneyi doğrular.

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

Ham baytları, siz beyan ettiğiniz türe ayarlanmış Content-Type ile bir saat içinde uploadUrl’a PUT edin, ardından kimliği requests.create’ten referans alın:

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

• field, Belgeler bloğunun alan anahtarıdır. Formda tam olarak bir blok varsa isteğe bağlıdır; iki veya daha fazlasında zorunludur.

• Bloğun yazarın eklediği belgeleri kalır; sizinkiler bu tek alıcı için onların altında görünür.
• Sınırlar: belge başına 25 MB, istek başına 100 MB belge, yazarın eklediği belgeler dahil blok başına gösterilen 20 belge.

• Bir yükleme herhangi bir sayıda istek tarafından referans alınabilir. Kimsenin referans almadığı bir yükleme zamanla silinir. Baytlar, onlara referans veren son istek saklama süresi tarafından ayıklanana kadar çalışma alanı sahibinin depolama alanına sayılır.

Buradaki her başarısızlık, bir details.reason ile birlikte 400 VALIDATION_ERROR’dur: bu metoddan DOCUMENT_TYPE_NOT_ALLOWED, DOCUMENT_TOO_LARGE, INVALID_DOCUMENT_NAME ya da INVALID_DOCUMENT_SHA256, ve requests.create’ten DOCUMENT_NOT_FOUND, DOCUMENT_NOT_UPLOADED (PUT’u atladınız), DOCUMENT_INVALID, INVALID_DOCUMENT_TARGET, DOCUMENTS_TOO_LARGE ya da DOCUMENTS_TOO_MANY.

Bir form için webhook aboneliklerini listeler.

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

Bir URL’yi form olaylarına abone eder: yeni veya terk edilmiş gönderimler, ya da formdaki isteklerin sona ermesi. URL HTTPS kullanmalıdır.

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

Terk edilmiş gönderim abonelikleri, seçilen idleWindow’ı hem webhooks.create hem de webhooks.list ’ten döner. Diğer her abonelik onu atlar.

Bir istek aboneliği, bir geri çağırmanın duyduğu aynı olayları duyar, ama kendi teslimatı olarak: kendi olay kimliği, kendi imzası ve kendi beş denemelik yeniden deneme bütçesiyle, bu tükendiğinde abonelik duraklar. Bir request_completed aboneliği olan bir formda callbackUrl ile oluşturulan bir istek bu yüzden iki kez tetiklenir, her alıcıya bir kez. requests.replayCallback yalnızca geri çağırmayı yeniden gönderir. İsteğin sona ermesinden önce yükü görmek için requests.sample kullanın.

Bir webhook aboneliğini kaldırır.

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

Bir form için toplu analitik metriklerini getirir. Tarih aralığı, cihaz, trafik kaynağı ve ülke filtrelerini destekler.

Analitik bir Pro özelliğidir ve kural, panodaki Analitik sekmesinde olduğu gibi çalışma alanı sahibinin planını izler. Sahip Pro değilse çağrı UPGRADE_REQUIRED döndürür — sahip Pro iken kaydedilmiş geçmiş için de. Pro sahibinin çalışma alanındaki Free bir üye verileri alır.

Oranlar 0’dan 100’e kadar sayılardır, sayımlar tam sayıdır ve totalEvents, benzersiz ziyaretçilere tekilleştirmeden önceki ham olay satırı sayısıdır.

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

Token’ınızın erişebildiği tüm çalışma alanlarını listeler. Parametre gerekmez.

Bir API token’ı tek bir çalışma alanına bağlıdır, bu yüzden hesabınız birden fazlasına üye olsa bile bu metod yalnızca o çalışma alanını döner.

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

Bir çalışma alanı için davet bağlantısı oluşturur.

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

Bir çalışma alanı davetini getirir. workspaces.createInvite ile aynı biçimi döner.

Mevcut bir çalışma alanı davetini günceller. expiresAt veya maxUses alanlarından en az birini sağlayın, aksi halde çağrı reddedilir. Güncellenmiş daveti döner.

Bir çalışma alanı davetini kalıcı olarak iptal eder.

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

Bir çalışma alanındaki klasörleri listeler.

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

Bir çalışma alanında klasör oluşturur. Idempotent — aynı ada sahip bir klasör zaten varsa mevcut klasörü döndürür.

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

Bir klasörü yeniden adlandırır veya farklı bir üst klasöre taşır.

Bir klasörü ve tüm içeriğini (alt klasörler ve formlar) kalıcı olarak siler.

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

Bir formda yapılandırılmış tüm dilleri listeler.

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

Bir forma dil kaydeder. Siz bunu yapana kadar diğer her çeviri metodu 404 NOT_FOUND ile başarısız olur.

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

Bir dili ve tüm çevirilerini formdan kaldırır.

Bir formdaki bir dil için mevcut durumuyla birlikte her kaynak anahtarı listeler. translations.setEntry’nin aldığı key değerlerini bu şekilde keşfedersiniz.

{
  "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, missing (hiçbir şey kaydedilmemiş), outdated (kaynak o zamandan beri değişti), current, ya da suggested (hazırlanmış ama kabul edilmemiş bir AI önerisi) olur. Anahtarlar form içeriğini ( block_<id>.) ve, bir yazar bunları özelleştirdiyse, yanıtlayıcı onay ve hatırlatma e-postalarını ( email.confirmation., email.reminder.*) kapsar.

Tek bir çeviri girişini ayarlar. Dilin önce translations.addLanguage ile eklenmiş olması gerekir.

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

{ formId, language, key } döner.

Tek bir çeviri girişini siler ve o anahtarı formun varsayılan diline geri döndürür. Idempotent. Bir dil için son giriş de gittiğinde, dil formun yayınlanmış dillerinden düşer.

Kimliği doğrulanmış kullanıcı hakkında bilgi getirir.

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

Bu dağıtımın sunduğu her metod adını sıralı olarak listeler. Bu sayfa ile sunucu anlaşmazlığa düştüğünde yetkili yanıt budur.

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