Skip to main content
GET
Get Interview Export Job

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

study_id
string
required
job_id
string
required

Response

Successful Response

job_id
string
required
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
completed
boolean
required

True when work has finished successfully

format
enum<string>
required
Available options:
csv,
jsonl
pii_redacted
boolean
required

Whether common structured identifiers were masked

result_url
string | null

Fetch the created resource after success

total_count
integer | null

Requested participant count for a batch

error
string | null

A safe failure summary; internal details are never returned

record_count
integer | null
next_page
integer | null
download_url
string | null

Private signed URL, valid for 15 minutes after polling a successful job