Skip to main content
Participant Interview State

Authorizations

Authorization
string
header
required

Short-lived token bound to one participant session.

Response

Successful Response

available
boolean
required
consented
boolean
required
status
enum<string>
required
Available options:
not_started,
active,
paused,
completed,
ended_incomplete
agent_connected
boolean
default:false
attempt
integer
default:0
Required range: x >= 0
interview_id
string<uuid> | null
item_kind
enum<string> | null
Available options:
question,
confirmation,
scenario,
screen_entry,
consistency_check,
ready_to_finish
item_text
string | null
missing
InterviewMissingItem · object[]
paused_reason
string | null
pending_proposal
InterviewProposalView · object | null
progress
number
default:0
Required range: 0 <= x <= 1
question
ParticipantSingleSelectQuestion · object
ready_to_finish
boolean
default:false
revision
integer
default:0
Required range: x >= 0
scenario
InterviewScenarioView · object | null
section
ParticipantSectionContext · object | null

The part of a core-order journey a page or question belongs to (participant-safe, localized).

target_minutes_max
integer | null
target_minutes_min
integer | null
unavailable_reason
string | null