v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
surveys

Create survey

You can create a survey with either sections -> questions or just questions. This allows you to decide how much flexibility you want in your survey design. However, if you want to render the survey in the Prolific Application, you must use sections.

post/api/v1/surveys/

Headers

Authorizationstring required

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Request body

researcher_idstring required

The Prolific researcher ID.

titlestring required

The survey title.

Response

Successful Response

_idstring

Auto generated by the system.

date_createdstring date-time

The date/time the survey was created (UTC).

date_modifiedstring date-time

The date/time the survey was modified (UTC).

researcher_idstring required

The Prolific researcher ID.

titlestring required

The survey title.