Skip to main content
GET
List Study assets

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Path Parameters

studyId
string<uuid>
required

Query Parameters

purpose
enum<string>

Return only assets with this purpose. Omit it to return every recorded asset.

Available options:
CONSENT_DOCUMENT,
QUESTION_IMAGE
limit
integer
default:50

How many assets to return per page.

Required range: 1 <= x <= 50
cursor
string

The cursor returned by the previous page. Omit it to read the first page.

Maximum string length: 999

Response

A page of Study assets.

A page of Study assets ordered by creation time, then id.

data
(Consent document · object | Question image · object)[]
required

An uploaded Study asset. Uploading does not attach it to a Question or change the Study version. width and height are present for QUESTION_IMAGE only.

cursor
string | null
required