GET
/smart-forms/:idGet Smart Form
Retrieve a single smart form by ID including session count
Scope: SMART_FORMS_READ
Overview
Returns the full details of a smart form owned by the authenticated user, including a session count aggregate.
Request
GET
/smart-forms/:idHeaders
| Header | Value |
|---|---|
Authorization | Bearer fxk_live_<your-api-key> |
Path Parameters
Example Request
curl -X GET "https://api.formfex.com/api/v1/public/smart-forms/SMART_FORM_ID" \
-H "Authorization: Bearer $FORMFEX_API_KEY"Response
Response Fields
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique smart form identifier |
userId | string (UUID) | Owner's user ID |
title | string | Display title |
purpose | string | Purpose prompt used by the AI to generate questions |
description | string | null | Respondent-facing description |
targetAudience | string | null | Target audience description |
languages | string[] | Configured language codes |
maxQuestions | number | Maximum questions per session (5–15) |
isPrivate | boolean | Whether email OTP verification is required |
publishStatus | string | DRAFT or PUBLISHED |
allowNewSessions | boolean | Whether new sessions can currently be started |
shortId | string | Short ID used in the public share URL |
createdAt | string (ISO 8601) | Creation timestamp |
updatedAt | string (ISO 8601) | Last update timestamp |
_count.sessions | number | Total number of sessions across all statuses |
n8n
In n8n, this operation is available as Get under the Smart Form resource in the Formfex node.