Skip to main content
GET
Get Interview

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

X-UI-Organization-ID
string | null

Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.

Maximum string length: 128

Path Parameters

interview_id
string
required

Query Parameters

message_offset
integer
default:0
Required range: x >= 0
message_limit
integer
default:50

Maximum segments; the response also stops near 20 KB of transcript text

Required range: 1 <= x <= 100
redact_pii
boolean
default:false

Mask email addresses, phone numbers, and US Social Security numbers in transcript and screener text; omit participant email and recording links. Pattern masking cannot detect every identifier.

Response

Successful Response

Interview detail with bounded, paged speech segments.

id
string
required
participant_source
enum<string>
required

Recruitment source; synthetic, anonymous panel and open-link respondents have no public person identity

Available options:
byop,
panel,
external_panel,
link,
synthetic,
unknown
study_id
string | null

The study this interview belongs to

participant
PublicInterviewParticipant · object | null

null for synthetic, anonymous panel, external-panel, or open-link interviews

status
string | null
quality
string | null

Quality rating: Excellent, Good, Fair, or Poor

ended_because
enum<string> | null

Why the interview ended; null if the stored reason cannot be classified

Available options:
completed,
participant_left,
time_limit,
technical_error,
screened_out
started_at
string<date-time> | null

Date and time the interview took place

ended_at
string<date-time> | null

Date and time the interview ended

interview_format
enum<string> | null

Stored interview mode; null when the historical mode is unknown

Available options:
chat,
video,
voice
language
string | null

Current configured study language, not a detected transcript language; historical interviews may have used an earlier configuration

duration_seconds
integer | null

Interview length in seconds (ended_at - started_at)

pii_redacted
boolean
default:false

True when common structured identifiers were masked and direct identity/media links omitted; this does not guarantee all PII was detected

messages
PublicTranscriptSegment · object[] | null

Spoken segments (up to message_limit and about 20 KB). Each has id, role, message, text_offset, and start_s/end_s when stored timing exists.

total_message_segments
integer
default:0
next_message_offset
integer | null
audio_recording_url
string | null
video_recording_url
string | null
screener_responses
PublicScreenerResponse · object[] | null

The participant's screener answers for this interview.