GET/smart-forms/:id/sessions/:sessionId

Get Session

Retrieve the full detail of a single smart form session including Q&A and AI analysis

Scope: SMART_FORMS_READ

Overview

Returns the complete detail of a session, including all questions and answers, AI analysis output, and token usage. The analysis field is null for sessions that have not yet completed their AI analysis job.

Request

GET/smart-forms/:id/sessions/:sessionId

Headers

HeaderValue
AuthorizationBearer fxk_live_<your-api-key>

Path Parameters

Example Request

curl -X GET "https://api.formfex.com/api/v1/public/smart-forms/SMART_FORM_ID/sessions/SESSION_ID" \
  -H "Authorization: Bearer $FORMFEX_API_KEY"

Response

Response Fields

FieldTypeDescription
idstring (UUID)Session identifier
respondentEmailstring | nullRespondent's email
respondentFirstNamestring | nullRespondent's first name
respondentLastNamestring | nullRespondent's last name
statusstringACTIVE, ANALYZING, COMPLETED, or EXPIRED
completionTypestring | nullnatural or early_exit
questionsAnswerednumberCount of answered questions
maxQuestionsnumberConfigured maximum questions
questionsAndAnswersarrayOrdered list of question/answer entries (see below)
questionsAndAnswers[].questionIndexnumberZero-based question index
questionsAndAnswers[].questionstringAI-generated question text
questionsAndAnswers[].answerstring | nullRespondent's answer. null if the question was not yet answered.
questionsAndAnswers[].insightstring | nullPer-answer AI insight generated at answer time. null if not yet available.
questionsAndAnswers[].answeredAtstring | nullISO 8601 timestamp when the answer was submitted
analysisobject | nullFull AI analysis result. null until the analysis job completes.
analysis.summarystringNarrative summary of the session
analysis.sentimentScorenumberSentiment score from −1.0 (negative) to 1.0 (positive)
analysis.completenessScorenumberCompleteness score from 0.0 to 1.0
analysis.mainSubjectstringPrimary topic of the session
analysis.keyThemesstring[]List of recurring themes identified
analysis.actionableInsightsstring[]Suggested actions derived from the session
creditsUsednumber | nullCredits consumed by the analysis job. null until analysis completes.
totalTokensUsednumber | nullTotal LLM tokens used across the session
completedAtstring | nullISO 8601 timestamp when the session was completed
createdAtstring (ISO 8601)Session start timestamp

Polling for Analysis Completion

If status is ANALYZING, poll this endpoint until status changes to COMPLETED and analysis is no longer null. Typical analysis takes 10–30 seconds.

n8n

In n8n, this operation is available as Get Session under the Smart Form resource in the Formfex node.