API Reference
Build complex forms without code. Integrate FormFlow into your workflow with our robust REST API. Access endpoints for form creation, submission retrieval, and webhook management.
Documentation Navigation
Authentication
API Keys, OAuth2 implementation, and rate limit policies.
Forms API
Endpoints for creating, updating, and deleting form definitions.
Submissions API
Retrieve entry data, export CSV files, and manage submission status.
Webhooks
Configure real-time event triggers and signature verification.
Base Configuration
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. Authentication is required via Bearer tokens in the Authorization header.
Base URL
https://api.formflow.io/v1
Authentication Header
Authorization: Bearer sk_live_51Mz8x9K2pQrT4vL
Rate Limits
100 requests per minute per API key. Burst limit: 20 req/s.
Core Endpoints
/v1/forms
Create a new form definition with fields, logic, and validation rules.
Request Body:
{
"title": "Q3 Customer Feedback",
"slug": "q3-feedback",
"fields": [
{"type": "text", "key": "name", "required": true},
{"type": "rating", "key": "satisfaction", "max": 5}
]
}
/v1/forms/{form_id}/submissions
Retrieve form entries with filtering, sorting, and pagination.
Query Params:
?status=submitted&created_after=2023-10-01&limit=50
Response Snippet:
{
"data": [
{"id": "sub_9x21", "data": {"name": "Alice Chen", "satisfaction": 5}}
],
"has_more": true
}
/v1/webhooks
Register webhook endpoints for real-time event notifications.
Request Body:
{
"url": "https://hooks.yourapp.io/formflow/events",
"secret": "whsec_482910x",
"events": ["submission.created", "form.updated"]
}