Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.formbase.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

The Formbase API provides programmatic access to your forms and submissions. Use it to build custom integrations, automate workflows, or manage your forms from external applications.

​
Base URL

All API requests should be made to: 
https://formbase.dev/api/v1

​
Authentication

The API uses Bearer token authentication with API keys. Include your API key in the Authorization header: 
curl -X GET "https://formbase.dev/api/v1/forms" \
  -H "Authorization: Bearer YOUR_API_KEY"
Keep your API keys secure. Don’t share them in public repositories or expose them in client-side code.

​
Creating API Keys

  1. Go to your Dashboard Settings
  2. Click “Create Key”
  3. Give your key a descriptive name
  4. Optionally set an expiration date
  5. Copy the key immediately - it won’t be shown again
API keys management page
Create API key dialog

​
Rate Limits

API requests are rate limited to 100 requests per minute per API key. Rate limit information is included in the response headers:
HeaderDescription
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit resets
When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait.

​
Error Responses

All errors follow a consistent format: 
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Form not found"
  }
}

​
Common Error Codes

HTTP StatusCodeDescription
400BAD_REQUESTInvalid request parameters
401UNAUTHORIZEDMissing or invalid API key
404NOT_FOUNDResource not found
429TOO_MANY_REQUESTSRate limit exceeded
500INTERNAL_SERVER_ERRORServer error

​
Pagination

List endpoints return paginated results with the following structure: 
{
  "forms": [...],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 45,
    "totalPages": 3
  }
}

​
Query Parameters

ParameterDefaultMaxDescription
page1-Page number
perPage20100Items per page

​
OpenAPI Specification

The complete OpenAPI specification is available at: 
https://formbase.dev/api/v1/openapi.json
You can use this specification with tools like Postman, Insomnia, or code generators.