GET
/smart-forms/:id/sessionsList Sessions
Retrieve a paginated list of sessions for a smart form
Scope: SMART_FORMS_READ
Overview
Returns a paginated list of sessions for the specified smart form. Each session includes derived fields such as questionsAnswered and extracted analysis scores (sentiment, completeness). Supports filtering by status and keyword search on respondent identity fields.
Request
GET
/smart-forms/:id/sessionsHeaders
| Header | Value |
|---|---|
Authorization | Bearer fxk_live_<your-api-key> |
Path Parameters
Query Parameters
Example Request
curl -X GET "https://api.formfex.com/api/v1/public/smart-forms/SMART_FORM_ID/sessions?page=1&limit=20&status=COMPLETED" \
-H "Authorization: Bearer $FORMFEX_API_KEY"Response
Response Fields
| Field | Type | Description |
|---|---|---|
sessions | array | Array of session summary objects |
sessions[].id | string (UUID) | Session identifier |
sessions[].status | string | ACTIVE, ANALYZING, COMPLETED, or EXPIRED |
sessions[].respondentEmail | string | null | Respondent's email address |
sessions[].respondentFirstName | string | null | Respondent's first name |
sessions[].respondentLastName | string | null | Respondent's last name |
sessions[].completionType | string | null | natural (all questions answered) or early_exit (exited before last question) |
sessions[].questionsAnswered | number | Number of questions answered in this session |
sessions[].maxQuestions | number | Maximum configured questions for the smart form |
sessions[].sentimentScore | number | null | AI-computed sentiment score (−1.0 to 1.0). null if not yet analyzed. |
sessions[].completenessScore | number | null | AI-computed completeness score (0.0 to 1.0). null if not yet analyzed. |
sessions[].mainSubject | string | null | AI-extracted main topic or subject of the session. null if not yet analyzed. |
sessions[].completedAt | string | null | ISO 8601 completion timestamp |
sessions[].createdAt | string (ISO 8601) | Session start timestamp |
total | number | Total matching sessions |
page | number | Current page number |
limit | number | Results per page |
hasMore | boolean | Whether more pages are available |
Analysis Scores
sentimentScore, completenessScore, and mainSubject are populated after the AI analysis job completes. Sessions in ANALYZING status will have null for these fields.
n8n
In n8n, this operation is available as Get Many Sessions under the Smart Form resource in the Formfex node.