Forms
Get Form
Returns the full configuration of a form or survey for rendering.
GET
Get Form
Returns the complete form definition including fields, validation rules, and display settings. Used to render the form for user input.Authentication
No authentication required for public forms.Path Parameters
Unique identifier (GUID) of the form.
Query Parameters
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation.
Response
Returns the form configuration object with the following fields.Form Fields
Identity
| Field | Type | Description |
|---|---|---|
Id | number | Unique numeric identifier for the form |
UniqueId | string | Globally unique identifier |
Core
| Field | Type | Description |
|---|---|---|
Name | string | Form display name |
Description | string | Form description / instructions |
Active | boolean | Whether the form is active |
Questions
Each form contains an array of question objects:| Field | Type | Description |
|---|---|---|
Id | number | Question identifier |
Text | string | Question text |
Description | string | Question description / help text |
QuestionType | string | Type of question (e.g. Text, Select) |
AvailableOptions | string | Comma-separated list of options |
AvailableOptionsArray | string[] | Array of option strings |
DisplayOrder | number | null | Sort order of the question |
AllowMultipleOptions | boolean | Whether multiple selections are allowed |
IsRequired | boolean | Whether the question is required |
Timestamps (from base)
| Field | Type | Description |
|---|---|---|
CreatedOn | string | Date created (business-local time) |
UpdatedOn | string | null | Date last updated (business-local time) |
CreatedOnUtc | string | Date created (UTC) |
UpdatedOnUtc | string | null | Date last updated (UTC) |