API overview

Endpoint

All requests go to a single URL via POST. Pass the method name and parameters as JSON.

POST https://api.formbase.so/api/v1

Authentication

Pass your API token as a bearer token in the Authorization header. Tokens are scoped to a workspace — create them from OAuth and API Keys in the sidebar.

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

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.list', params: {} }),
})
const 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.list", "params": {}},
)
data = res.json()

Request format

Every request is a JSON object with two fields:

{
  "method": "forms.list",
  "params": {
    "workspaceId": "abc123..."
  }
}

Response format

Every response is a JSON object with an ok field. On success:

{
  "ok": true,
  "data": { ... }
}

Errors

On failure, ok is false and an error object contains a machine-readable code and human-readable message:

{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'name' is required."
  }
}

Common error codes:

• VALIDATION_ERROR (400) — invalid or missing parameters

• UNAUTHORIZED (401) — missing or invalid API token

• UPGRADE_REQUIRED (402) — the feature requires a higher subscription tier

• FORBIDDEN (403) — token lacks access to the resource

• CONFLICT (409) — resource state conflict, such as a duplicate name

• NOT_FOUND (404) — resource does not exist

• METHOD_NOT_FOUND (404) — unknown method name

• RATE_LIMITED (429) — too many requests

• INTERNAL_ERROR (500) — unexpected server error

Rate limits

API requests are rate-limited to 120 requests per minute per token. Exceeding the limit returns 429 Too Many Requests.

Next steps