Skip to main content
GET
List Studies

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
Required range: 1 <= x <= 50
cursor
string
Maximum string length: 999
status
enum<string>
Available options:
DRAFT,
IN_PROGRESS,
PAUSED,
COMPLETED,
ARCHIVED
type
enum<string>

Returns only Studies of this public type.

Available options:
SURVEY,
IN_PRODUCT_SURVEY
platform
enum<string>

Returns only IN_PRODUCT_SURVEY Studies on this platform. Cannot be combined with type SURVEY.

Available options:
WEB,
MOBILE

Response

A page of Studies.

A cursor-paginated page of Studies.

data
(Shareable survey · object | In-product survey · object)[]
required

A Study discriminated by its public type.

cursor
string | null
required