v1

latestOpenAPI 3.1.02026-07-226130.1 KB

Retrieve Surveys

Studies were formerly surveys. This endpoint allows for the export of study configurations. The name will eventually change to Study, but at this time survey will be accepted anywhere study appears in the API. This endpoint allows you retrieve up to 1000 surveys at a time.

get/v1/surveys

Query parameters

startinteger

The earliest creation data for a generated theme to return, represented as milliseconds from epoch time

endinteger

The latest creation date for a generated theme to return, represented as milleseconds from epoch time

cursorstring

A Base64 encoded string representing an opaque cursor position

statusstring[]

One or many of (IN_PROGRESS, PAUSED, COMPLETED, DRAFT, ARCHIVED, NEW). Can be passed as ?status=PAUSED,COMPLETED, ?status[]=PAUSED&status[]=COMPLETED or ?status=PAUSED&status=COMPLETED

limitinteger

Specific number of results to return

Headers

Authorizationstring required

Bearer YOUR_API_KEY

Response

cursorstring