> For the complete Lynkow documentation index in agent-friendly format, see [llms.txt](/llms.txt). # SDK Types: Forms **Publié le** : 2026-08-20 **Catégorie** : Types # SDK Types: Forms > **Related services:** **FormsService** — `lynkow.forms.getBySlug()`, `lynkow.forms.submit()` ## `Form` *Interface* A public form available for submission. Returned by `GET /storefront/{siteId}/forms/{slug}` and unwrapped from the `{ data }` envelope by `forms.getBySlug()`. Use `schema.fields` to dynamically render the form fields, `schema.settings` to configure the submit button and post-submission behavior, and the spam protection flags to set up honeypot or reCAPTCHA if enabled. Only forms with `status: 'active'` are returned by the public API. Draft, closed, and archived forms are never returned. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `description` | `string \| null` | No | Optional form description, displayed above the form fields.
`null` if not set. Max 1000 characters.
Can be used as introductory text or instructions for the user. | | `honeypotEnabled` | `boolean` | Yes | Whether honeypot spam protection is enabled for this form.

When `true`, your frontend **must** render a hidden honeypot field
(invisible to humans, filled by bots). The SDK handles this automatically
via `lynkow.forms.submit()`, but if you submit manually, include an empty
hidden field named per the spam protection API specification.

`undefined` or `false` means honeypot is not active. | | `id` | `string` | No | Unique form identifier (UUID v4). | | `locale` | `string` | Yes | BCP 47 locale code of this form (e.g. `'en'`, `'fr'`).
`undefined` if the form is not locale-specific (shared across all locales). | | `name` | `string` | No | Form display name (e.g. `'Contact Us'`, `'Newsletter Signup'`). Max 255 characters. | | `recaptchaEnabled` | `boolean` | Yes | Whether Google reCAPTCHA v3 is enabled for this form.

When `true`, your frontend must:
1. Load the reCAPTCHA script using `recaptchaSiteKey`
2. Execute `grecaptcha.execute()` before submission
3. Include the reCAPTCHA token in the submission payload

The SDK handles this automatically if you use `lynkow.forms.submit()`.
Cannot be combined with honeypot; only one spam protection method is active.

`undefined` or `false` means reCAPTCHA is not active. | | `recaptchaSiteKey` | `string \| null` | Yes | Google reCAPTCHA v3 public site key, needed to render the reCAPTCHA widget.
Only present when `recaptchaEnabled` is `true`.
`null` or `undefined` when reCAPTCHA is not configured.

Pass this to `grecaptcha.render()` or the `sitekey` parameter in the reCAPTCHA script URL.
The secret key is never exposed; it stays server-side. | | `schema` | `FormSchema` | No | Schema describing the form's fields, layout, behavior settings, and
conditional logic. Iterate `schema.fields` to render the form. | | `slug` | `string` | No | URL-friendly slug, unique within the site.
Lowercase, hyphenated (e.g. `'contact-us'`). Max 255 characters.
Used to fetch the form: `GET /storefront/{siteId}/forms/{slug}`.
Also used as the submission endpoint: `POST /storefront/{siteId}/forms/{slug}/submissions`. | | `status` | `"active"` | No | Form status. Always `'active'` via the public API.
Draft, closed, and archived forms are never returned by public endpoints. | --- ## `FormCondition` *Interface* Conditional logic rule applied to a form field. When the referenced `field` matches the operator/value combination, the `action` is applied (show, hide, require, or skip to a target page). Used for dynamic forms where some fields appear conditionally based on earlier answers. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `action` | `"show" \| "hide" \| "require" \| "skip_to_page"` | No | Effect applied when the condition matches:
- `'show'` / `'hide'`: toggle visibility of the target field
- `'require'`: mark the target field required
- `'skip_to_page'`: jump to the page identified by `targetPage` | | `field` | `string` | No | The `FormField.id` of the field whose value triggers this condition. | | `operator` | `"equals" \| "not_equals" \| "contains" \| "not_contains" \| "greater_than" \| "less_than" \| "is_empty" \| "is_not_empty"` | No | Comparison operator applied to the referenced field's current value. | | `targetPage` | `number` | Yes | Target page index for `skip_to_page` actions.
Ignored for other actions. | | `value` | `unknown` | Yes | Value compared against the referenced field. Type depends on the field
type: string for text fields, number for number fields, boolean for
checkboxes. `undefined` for `is_empty` / `is_not_empty`. | --- ## `FormField` *Interface* A single field definition in a form schema. Describes the input type, label, validation, and layout for one form field. Use these to dynamically render form fields in your frontend. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `conditions` | `FormCondition[]` | Yes | Per-field conditional logic. When present, the field is only rendered or
required based on the values of earlier fields. Conditions defined here
are scoped to this field; cross-field rules live in `FormSchema.conditions`. | | `defaultValue` | `string \| number \| boolean` | Yes | Pre-filled default value for the field.
Type depends on the field type: `string` for text fields, `number` for number fields,
`boolean` for checkbox (single toggle mode).
`undefined` if no default is set. The field starts empty. | | `description` | `string` | Yes | Help text displayed below the input to guide the user.
Max 500 characters. `undefined` if not configured.
Render as a small description below the field (e.g. `` or `aria-describedby`). | | `id` | `string` | No | Field identifier, used as the key in submission data.
Auto-generated by the admin (e.g. `'field_1764776796820'`), unique within
the form. This is the key you must use in `FormSubmitData` when calling
`forms.submit()`. | | `label` | `string` | No | Human-readable label displayed above or beside the input.
Max 255 characters. Always present. Use this as the `