List studies

Create a mutually exclusive study collection.

• Studies and study collections must be created separately and then added to the mutually exclusive study collection.
• Both the studies and the study collection must be in the same project.
• You can only add draft studies to a mutually exclusive study collection.
• Adding studies which are already in one study collection to another study
  collection will remove the study from the original study collection.

Delete a mutually exclusive study collection. This will not delete the studies in the collection.

• This can only be completed if the study collection is unpublished.
• This will not delete the studies in the collection.

Get a mutually exclusive study collection

Update a mutually exclusive study collection

Transition a mutually exclusive study collection. This is used to:

• Publish a study collection
• Cancel publish a study collection
• Schedule publish a study collection
  • This can be done by setting the publish_at on the study collection at create or patch, then transitioning with the “SCHEDULE_PUBLISH” action
  • Or optionally the publish_at can be provided directly in the body of the transition request

Returns basic information of the submissions, including the study id, participant id, status and start timestamp

Bulk approve study submissions to pay participants after they have
completed your survey or experiment. There are two variant payloads to
this request.

1. You can supply a Study ID, and a list of participant IDs, or
2. You can provide a list of submission IDs

Returns the detailed information of a submission, including the
study id, participant id, status and start timestamp

This is an experimental feature that may be subject to change in the future.

It offers researchers the ability to ask a participant to return a submission. The return reason must be provided in the request and can be any free text string.
The Prolific UI allows users to select any of the following options:

• Didn’t finish the study
• Encountered technical problems
• Withdrew consent
• Other ( uses the free text input)

This constructs a message around the reasons provided so there is no need to provide additional text beyond the reasons.

Transition a submission to APPROVED or REJECTED. Once the status is changed, it can not be restored to its previous value.

We strongly recommend that, when giving approval to a submission through the API, you first observe the submission.status.change
event for a status transition to
AWAITING_REVIEW before making the approval request. Our system is currently unable to process approvals before this transition.
Note this endpoint is idempotent, so if you make the same request twice, the second request will be ignored.

Get all the surveys for a researcher.

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.

Delete a single Survey.

Get a single survey given an ID.

Delete all the responses for a given Survey.

Get all the responses for a given Survey.

Create a Response for a survey.

Get an aggregated summary of responses for a given survey.

Delete a single Response.

Get a single response for a survey.

Use this endpoint to test your token and retrieve the basic information of your account.

Add an Authorization header with the value Token <your token>.

Gets a list of all workspaces that the user is a member of.

Creates a new workspace and adds the user as a Workspace Admin.

Gets a workspace’s details

Updates a workspace’s details.

Provides details of the funds available in the workspace.