Skip to main content
GET
Get Study Embed Code

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

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

study_id
string
required

Query Parameters

type
enum<string>
default:widget

Return a full interview widget or a link styled as a button

Available options:
widget,
button

Response

Successful Response

Copy-ready HTML for embedding a study on another website.

type
enum<string>
required
Available options:
widget,
button
code
string
required

Copy-ready HTML embed code

Universal interview link used by the embed