Skip to main content
GET
List Participants

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

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:20
Required range: 1 <= x <= 100
study_id
string | null

Filter by study

email
string | null

Filter by email

external_id
string | null

Exact customer ID; requires study_id

Required string length: 1 - 128

Response

Successful Response

participants
PublicParticipant · object[]
required
total_count
integer
required
page
integer | null
page_size
integer | null