> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview Form

> Returns the preview configuration for a form or survey.

# Preview Form

Returns the form schema and configuration for preview purposes. Used to render forms before they are submitted.

## Authentication

No authentication required.

## Path Parameters

<ParamField path="formId" type="string" required>
  Unique identifier (GUID) of the form.
</ParamField>

## Query Parameters

<ParamField query="_shape" type="string">
  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.
</ParamField>

## Response

Returns the form schema with field definitions, validation rules, and layout. Same structure as [`GET /api/public/forms/{formId}`](/api/endpoints/forms/get-form) — see that endpoint for the full field breakdown.

### 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      |

## TypeScript Integration

```typescript theme={null}
import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.forms.preview('abc123'))
```