Skip to main content
GET
Get Study

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

Response

Successful Response

Full study shape returned by get-by-id (includes the heavy fields).

id
string
required
study_type
enum<string>
required

Current study-type template slug

Available options:
in-depth-interview,
concept-test,
prototype-test
provisioning_status
enum<string>
required

draft when required interviewer settings are missing, ready when the study can be provisioned, and provisioned when interviews can run

Available options:
draft,
ready,
provisioned
fielding_status
enum<string>
required

Recruitment state, separate from interviewer provisioning. Panel studies report their persisted lifecycle. BYOP studies are collecting once the interviewer is provisioned, and can be paused or stopped; invitation delivery is tracked per participant. Synthetic respondents are not_applicable.

Available options:
not_started,
starting,
collecting,
fielding,
paused,
complete,
partial,
failed,
stopped,
unavailable,
not_applicable,
unknown
name
string | null
Maximum string length: 40
use_case
string | null

Historical study-type label when it is outside the current catalog

recruiting_method
enum<string>

panel, byop, or synthetic_respondents

Available options:
panel,
byop,
synthetic_respondents
interview_format
enum<string> | null

chat, video, or voice

Available options:
chat,
video,
voice
voice
enum<string> | null

male or female

Available options:
male,
female
language
string | null

Interview language code, e.g. 'en'

expected_duration_seconds
integer
default:900

Maximum planned interview duration in seconds, including transitions and likely follow-up probes. This is an estimate, not a guaranteed length.

Required range: x >= 300
byop_config
PublicByopConfigOut · object

Live participant interview link; null until the interviewer is provisioned. This is not a researcher preview URL.

dashboard_url
string | null

Researcher management link for the study

missing_requirements
string[]

Fields still required before the study can be provisioned

created_at
string<date-time> | null
updated_at
string<date-time> | null
interview_count
integer | null

Completed visible non-test interviews satisfying quality criteria, matching list_interviews(status=completed).

report_status
enum<string> | null
Available options:
available,
not_generated
study_plan
PublicStudyPlanOut · object | null

Response variant — all sections optional (a study's stored prompt may not contain every section).

screener_questions
PublicScreenerQuestion · object[] | null
targeting_attributes
PublicTargetingAttribute · object[] | null
resolved_targeting
PublicResolvedTargeting · object[]

Human-readable interpretation of the configured panel targeting

concept_images
PublicConceptImage · object[]
invitation_count
integer | null

Invitation records for this study. A panel launch may use one invitation for many participants.

interview_attempt_count
integer | null

Interview attempts, including attempts that did not yield a quality interview.

quality_interview_count
integer | null

Interviews that passed the study quality criteria.