API Reference
Sign InGet Started Free

Retrieve Surveys

get
https://api.sprig.com/v1/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.

Query Params
integer

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

integer

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

string

A Base64 encoded string representing an opaque cursor position

status
array of strings

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

status
integer
1 to 1000

Specific number of results to return

Headers
string
required

Bearer 8abaf7cb-fake-fake-fake-c608317728bd

Responses

403

You may have an invalid or missing API key and you should check your authorization header. There is no message with this status code.

429

Your application has made too many requests in too short a time.

500

Something went wrong on Sprig's side. These are very rare :)

Updated 5 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago