GET
/forms/:idGet Form
Retrieve a single form by ID with its full schema
Scope: FORMS_READ
Overview
Returns the complete form record including the full schema with all fields, sections, settings, and metadata. Use this endpoint when you need the full form definition.
Request
GET
/forms/:idPath Parameters
Headers
| Header | Value |
|---|---|
Authorization | Bearer fxk_live_<your-api-key> |
Example Request
curl -X GET "https://api.formfex.com/api/v1/public/forms/FORM_ID" \
-H "Authorization: Bearer $FORMFEX_API_KEY"Response
Response Fields
| Field | Type | Description |
|---|---|---|
data.id | string | Unique form identifier (UUID) |
data.userId | string | Owner's user ID |
data.title | string | Form title |
data.schema | FormSchema | Complete form schema (see below) |
data.publishStatus | string | DRAFT, PUBLISHED, or ARCHIVED |
data.publishVisibility | string | PUBLIC or PRIVATE |
data.publishedAt | string | null | ISO 8601 publish timestamp |
data.expiresAt | string | null | ISO 8601 expiry timestamp |
data.shareUrl | string | null | Short sharing slug |
data.isActive | boolean | Whether the form is active (not soft-deleted) |
data.createdAt | string | ISO 8601 creation timestamp |
data.updatedAt | string | ISO 8601 last update timestamp |
FormSchema Structure
| Field | Type | Description |
|---|---|---|
schema.version | string | Schema format version (e.g., "1.0") |
schema.schemaVersion | string | Schema revision (e.g., "2026-02") |
schema.meta | object | Form metadata: title, description, language, submitLabel, isAICreated |
schema.settings | object | Form settings: layout (single-column | two-column), submitAction, redirectUrl |
schema.sections | Section[] | Array of form sections with id, title, description, order, conditionalLogic |
schema.fields | Field[] | Array of form fields (see Add Field for the full field structure) |
Field Properties
| Property | Type | Description |
|---|---|---|
id | string | Unique field identifier |
sectionId | string | ID of the section this field belongs to |
type | string | Field type: text, textarea, number, email, select, radio, checkbox, date, file |
label | string | Display label |
order | number | Display order within the section |
required | boolean | Whether the field is mandatory |
hint | string | Helper text shown below the field |
placeholder | string | Placeholder text |
defaultValue | any | Default value |
options | array | Options for select/radio/checkbox (each with label and value) |
fileConfig | object | File upload config: maxSizeMB, allowedTypes |
validation | object | Validation rules (see Create Form) |
conditionalLogic | object | Conditional visibility (see Create Form) |
Section Properties
| Property | Type | Description |
|---|---|---|
id | string | Unique section identifier |
title | string | Section heading |
description | string | Optional section description |
order | number | Display order |
conditionalLogic | object | Conditional visibility — same structure as field conditional logic |
n8n
In n8n, this operation is available as Get under the Form resource in the Formfex node.