Preview Form

Returns the preview configuration for a form or survey.

GET /api/public/forms/{formId}/preview

Preview Form

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/forms/{formId}/preview \
  --header 'Authorization: Basic <encoded-value>'

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

formId · string · required

Unique identifier (GUID) of the form.

Query Parameters

_shape · 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.

Response

Returns the form schema with field definitions, validation rules, and layout. Same structure as GET /api/public/forms/{formId} — 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

import endpoints from '@/api/endpoints'

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