Skip to main content
GET
Get the JSON Schema for submitting to a published form

Authorizations

Authorization
string
header
required

Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx. The scope required by each endpoint is listed in that endpoint's description.

Headers

X-Form-Access-Password
string

Access password, when the form is password-protected

Path Parameters

form_token
string
required

Token of a published form

Response

Success

data
object
required

A JSON Schema (draft 2020-12) document for field_values: one property per field of the form that holds a value, keyed by api_code, each carrying the field's label as title, its type in description, and the exact value shape it accepts — choice api_codes, number ranges, statement and column keys. Read-only fields, and the entry's own keys an entry read carries (serial_number, token, created_at, info_*, ...), are listed with readOnly: true; a value sent for them is accepted and ignored, so an entry as read can be written back whole. Feed it to any JSON Schema validator, or use it as tool parameters for an LLM. Required fields are not marked: whether a field must be filled can depend on other answers, and is checked when the entry is written.