> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gavai.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Forms
> List form definitions and retrieve paginated submission records captured from your published pages.
export const ErrorTable = ({errors}) =>
Error
Cause
Fix
{errors.map((err, i) =>
{err.code}
{err.cause}
{err.fix}
)}
;
export const Def = ({term, type, defaultValue, required, children}) => <>
{term}
{type && {type}}
{required && required}
{defaultValue !== undefined &&
default {defaultValue}
}
{children}
;
export const DefList = ({children}) => {children}
;
export const ExpectedOutput = ({caption = "Expected output", children}) => ;
export const APIBadge = ({method = "GET", path, scope}) => {
const m = method.toUpperCase();
return
{m}
{path}
{scope &&
scope
{scope}
}
;
};
export const Eyebrow = ({label, tone = "default"}) =>
{label}
;
Forms are authored in the Builder by adding a Form block to a page and binding its fields to a schema-defined table. This resource gives you read access to the form definitions and their submissions. Form creation is Builder-only — there are no write endpoints for form schemas. Submissions are written by end-users filling out the rendered form on your live page, not through this API. By the end of this page you will know what reads exist, how submissions are paginated, and what the on-submit hook represents.
## A submission in shape
```json theme={null}
{
"id": "sub_01H...",
"form_id": "frm_01H...",
"data": { "name": "Alex Kim", "email": "alex@example.com", "company": "Acme" },
"submitted_at": "2026-05-09T09:22:11Z"
}
```
`data` keys mirror the field names on the form definition; values are the end-user input.
## Endpoints
List all forms in the workspace.
Fetch the schema for a specific form.
Paginated submission records for a form.
All three endpoints require `forms:read`. There are no write endpoints — forms must be created and edited in the Builder.
## What a form definition carries
Stable form identifier (`frm_01H...`).
Display name set in the Builder.
The schema-defined table submissions are written into.
Ordered list of field names; each maps to a column on `schema_table`.
Text on the form's submit button.
Optional capability invocation fired after a submission is recorded — `{ capability, args }`.
The `on_submit` hook lets a form trigger a workspace capability — typically `sendEmail` for confirmation — without separate wiring.
## Submissions pagination
`GET /forms/{id}/submissions` returns submissions newest-first, with cursor pagination. Defaults: `limit=50`, maximum `200`. Cursor mechanics match the [Pagination](/api-reference/pagination) protocol; the response shape is the standard `data` + `next_cursor` envelope, with an extra boolean `has_more`.
## Limits
Forms are Builder-authored. No POST, PATCH, or DELETE on form definitions.
Submissions are end-user writes from rendered pages. No endpoint creates or modifies a submission.
Not currently supported through the API. Contact support if you need it for data-compliance reasons.
## Common errors
## Related
Add a Form block, bind it to a schema table, and wire an on-submit capability in the Builder.