API Reference

Access the FormWork REST API documentation and OpenAPI specification.

The FormWork API provides full programmatic access to forms, entries, data tables, and workflows. Complete documentation is available via our OpenAPI specification.

API Documentation

Interactive API Docs

Browse endpoints, view schemas, and test requests directly in your browser.

View API Documentation

OpenAPI Specification

Download the OpenAPI 3.0 specification to generate client libraries or import into tools like Postman.

Format	URL
JSON	openapi.json
YAML	openapi.yaml

Quick Start

Base URL

https://app.useformwork.com/api/v1/

Authentication

All API requests require an API key passed in the Authorization header:

curl -H "Authorization: Bearer fwk_your_api_key" \
  https://app.useformwork.com/api/v1/forms

See API Keys for creating and managing keys.

Example Request

const response = await fetch('https://app.useformwork.com/api/v1/forms', {
  headers: {
    'Authorization': 'Bearer fwk_your_api_key',
    'Content-Type': 'application/json'
  }
});

const { data } = await response.json();

Key Endpoints

Resource	Endpoint	Description
Forms	`GET /forms`	List and manage forms
Entries	`GET /forms/{id}/entries`	Form submissions
Data Tables	`GET /data-tables`	Structured data storage
Workflows	`GET /workflows`	Automation workflows

For complete endpoint documentation, request/response schemas, and examples, see the interactive API docs.

Rate Limits

Limit	Value
Per minute	100 requests
Per hour	1,000 requests
Per day	10,000 requests

Rate limit headers are included in all responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1634567890

Need Help?

Browse the interactive docs for endpoint details
Check API Keys for authentication setup
Review Workflows for automation options