Forms
GET
Get Form
GET /v1/forms/{formId}Retrieve a specific form by ID with full configuration.
Use Cases:
- Fetch form details for rendering
- Check form status before editing
- Retrieve form configuration for frontend
- Verify form settings
- Get embed code parameters
Behavior:
- Returns forms in any status (DRAFT, PUBLISHED, ARCHIVED)
- Includes complete form builder configuration
- Shows form version information
- Published forms include publishedAt timestamp
- Includes submission statistics
- Form must belong to your workspace
Required Scope: read:forms
Response Includes:
- Form identification (id, name, slug)
- Display information (title, description)
- Status (DRAFT, PUBLISHED, ARCHIVED)
- Form builder configuration (fields)
- Settings (redirectUrl, submitText)
- Version information (rootFormId, publishedVersionId)
- Statistics (submission count)
- Timestamps (createdAt, updatedAt, publishedAt)
Form Status:
- DRAFT: Editable, not publicly accessible
- PUBLISHED: Live and accepting submissions, immutable
- ARCHIVED: Previous version, read-only
Note: Use the slug or ID to embed forms on your website.
Path parameters
formIdstringrequiredForm ID
Response
200Successfully retrieved form with complete configuration, version info, and submission statistics
objectstringrequiredidstringrequiredUnique form identifier