How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Prolific

Prolific studies API

The studies API from Prolific — 18 operation(s) for studies.

Documentation Provider Profile APIs.io OpenAPI GitHub

Prolific studies API is one of 28 APIs that Prolific publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Studies. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 21 operations across 18 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.prolific.com.

21 operations 18 paths 96 schemas 2 DELETE11 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.prolific.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Prolific studies API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (token).

  • token — 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…

Paths & Operations 21

Across 18 paths, the API surfaces 21 operations — 2 DELETE, 11 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

studies 21
GET
/api/v1/studies/
List all studies
get-studies 2 params → 200400
POST
/api/v1/studies/
Create a draft study
create-study 1 param body → 201400
GET
/api/v1/projects/{project_id}/studies/
List all studies in a project
get-project-studies 5 params → 200400
DELETE
/api/v1/projects/{project_id}/studies/{study_id}/
Delete a study from a project
delete-project-study 3 params → 204400
GET
/api/v1/studies/{id}/
Retrieve a study
get-study 2 params → 200400
DELETE
/api/v1/studies/{id}/
Delete a study
delete-study 2 params → 200400
PATCH
/api/v1/studies/{id}/
Update a study
update-study 2 params body → 200400
POST
/api/v1/studies/{id}/transition/
Transition a study's status
publish-study 2 params body → 200400
POST
/api/v1/studies/{id}/test-study
Create a test study
create-test-study 2 params → 200400
GET
/api/v1/studies/{id}/access-details-progress/
Get taskflow progress
get-study-access-details-progress 2 params → 200400
GET
/api/v1/studies/{id}/cost/
Show Study cost
get-study-cost 3 params → 200400
GET
/api/v1/studies/{id}/submissions/
List study submissions
get-study-submissions 3 params → 200400
GET
/api/v1/studies/{id}/submissions/counts/
Count study submissions by status
count-study-submissions-by-status 2 params → 200400
GET
/api/v1/studies/{id}/credentials/report/
Download credential usage report
download-study-credential-report 2 params → 200400
GET
/api/v1/studies/{id}/export/
Download demographic data
export-study 2 params → 200400
POST
/api/v1/studies/{id}/demographic-export/
Export demographic data
export-demographic-data 2 params body → 200400
GET
/api/v1/studies/{id}/demographic-export-history/
Get demographic export history
get-demographic-export-history 2 params → 200400
POST
/api/v1/studies/{id}/clone/
Duplicate a study
duplicate-study 2 params body → 200400
GET
/api/v1/studies/{study_id}/predicted-recruitment-time/
Show Study predicted recruitment time
get-study-predicted-recruitment-time 2 params → 200400
POST
/api/v1/studies/predicted-recruitment-time/
Show Study predicted recruitment time
post-study-predicted-recruitment-time 1 param body → 200400
POST
/api/v1/study-cost-calculator/
Calculate the study cost
calculate-study-cost 1 param body → 200400

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are Study (32 properties), BaseStudy (29 properties), CreateStudy (29 properties), StudyShort (16 properties). Each schema is shown below with its type and property counts.

RangeFilterWeightingsSelectedRange
object
2 properties
CreateStudyStudyLabelsItems
string
RangeFilterWeightingsSelectedRangeUpper
SubmissionShortStatus
string
Status of the submission.
CreateStudyDeviceCompatibilityItems
string
ErrorDetail
object
7 properties 4 required
DemographicExportRequest
object
1 property
DynamicPayment
object
1 property 1 required
CompositeFilterFilterId
string
Composite filter group operator. Use and when every child filter must match, or or when at least one child filter must match.
BaseStudySubmissionsConfig
object
Advanced: This helps with faster data collection. Your survey system will need to handle providing a unique experience each time the participant takes the stud…
3 properties
StudyShortStudyType
string
Deprecated. Type of study.
CreateStudyCompletionCodesItemsActionsItems
AutomaticallyApprove
object
1 property 1 required
StudyTransitionAction
string
The transition action to execute on the study.
StudyPredictedRecruitmentTimeRequestPeripheralRequirementsItems
string
StudyCostBreakdown
object
3 properties
RemoveFromParticipantGroup
object
2 properties 2 required
BaseStudyDataCollectionMetadata
object
Optional. Additional metadata for configuring AI Task Builder data annotation behavior. Only used when datacollectionmethod is set to AITASKBUILDERBATCH. Prope…
1 property
AddToParticipantGroupAction
string
Adds participants to a specific group
StudyTotalCost
object
3 properties
SubmissionShort
object
8 properties 5 required
StudyShort
object
16 properties 2 required
ManuallyReview
object
1 property 1 required
DemographicExportHistoryResponseFiltersItems
RangeFilterSelectedRange
object
This schema applies for filters of the range type, as defined in the [filter list response](\tag/Filters/paths/~1api~1v1~1filters~1/get). A dictionary with two…
2 properties
StudyCostRequest
object
2 properties 2 required
BaseStudyDeviceCompatibilityItems
string
AmountAndCurrency
object
2 properties
BaseStudyAccessDetailsItems
AddToParticipantGroup
object
2 properties 2 required
ErrorDetailDetail2
object
All fields with validation errors
1 property
CompositeFilter
object
2 properties 2 required
CreateStudyDataCollectionMethod
string
Optional. Specifies the data collection method for the study. - AITASKBUILDERBATCH: Use AI Task Builder for data annotation tasks. - AITASKBUILDERCOLLECTION: U…
StudyCostResponse
object
1 property 1 required
BaseStudyCompletionCodesItemsActionsItems
BaseStudyPeripheralRequirementsItems
string
RangeFilterSelectedRangeUpper
Your selected upper bound for the range.
CreateStudySubmissionsConfigAutoRejectionCategoriesItems
string
RangeFilterSelectedRangeLower
Your selected lower bound for the range.
ApiV1StudiesGetParametersState
string
CreateStudyDataCollectionMetadata
object
Optional. Additional metadata for configuring AI Task Builder data annotation behavior. Only used when datacollectionmethod is set to AITASKBUILDERBATCH. Prope…
1 property
Error
object
1 property 1 required
RangeFilter
object
3 properties 2 required
StudyPredictedRecruitmentTimeRequestDeviceCompatibilityItems
string
CreateStudyCompletionCodesItemsCodeType
string
A name for your code to make it easier to understand its intention. Either use one of the predefined options or any other free text.
BaseStudyProlificIdOption
string
Use 'question' if you will add a question in your survey or experiment asking the participant ID Recommended Use 'urlparameters' if your survey or experiment c…
CreateStudySubmissionsConfig
object
Advanced: This helps with faster data collection. Your survey system will need to handle providing a unique experience each time the participant takes the stud…
3 properties
CreateStudyContentWarningsItems
string
BaseStudyFiltersItems
BaseStudy
object
29 properties
BaseStudyCompletionCodesItemsActor
string
The actor that can provide this completion code.
StudyShortStatus
string
Status of the study.
CreateStudyPeripheralRequirementsItems
string
ErrorDetailDetail
Error detail
RequestReturnAction
string
Requests the participant to return their study
StudyStatus
string
Status of the study. Read only. To change the status you can use /api/v1/studies/{id}/transition/
BaseStudyContentWarningsItems
string
ManuallyReviewAction
string
Moves submission for the data collector to be manually reviewed.
CreateStudy
object
29 properties 7 required
CompositeFilterSelectedFiltersItems
StudyPredictedRecruitmentTimeResponse
object
5 properties
AutomaticallyApproveAction
string
Automatically approves submission with payment being processed immediately
StudyPredictedRecruitmentTimeRequestFiltersItems
DemographicExportHistoryResponse
object
Response containing the latest demographic export request history for a study
2 properties 2 required
FixedScreenOutAction
string
Use this action to set up a fixed screen out reward study. This feature is currently available to select workspaces only. - A fixed screen out reward study com…
DemographicExportRequestFiltersItems
SubmissionListResponse
object
1 property 1 required
StudiesListResponse
object
1 property 1 required
StudyAccessDetailsProgress
object
3 properties 2 required
FixedScreenOut
object
Use this action to set up a fixed screen out reward study.
3 properties 3 required
DynamicPaymentAction
string
Use this action to set up a dynamic payment study. Only certain workspaces have access to this feature. When using this action, the actor must be "researcher".
BaseStudyCompletionCodesItems
object
4 properties 3 required
TestStudySetUpResponse
object
2 properties
Study
object
32 properties 7 required
StudyPredictedRecruitmentTimeRequestStudyLabels
string
The field that the study is about to get tagged with.
SelectFilter
object
3 properties 2 required
AccessDetailProgress
object
4 properties 2 required
BaseStudyDataCollectionMethod
string
Optional. Specifies the data collection method for the study. - AITASKBUILDERBATCH: Use AI Task Builder for data annotation tasks. - AITASKBUILDERCOLLECTION: U…
CreateStudyFiltersItems
StudyPredictedRecruitmentTimeRequest
object
9 properties 6 required
SubmissionsCountResponse
object
10 properties
CreateStudyCompletionCodesItems
object
4 properties 3 required
AccessDetail
object
2 properties 2 required
RangeFilterWeightings
object
2 properties 2 required
BaseStudySubmissionsConfigAutoRejectionCategoriesItems
string
CreateStudyAccessDetailsItems
StudyPredictedRecruitmentTimeRequestStudyType
string
Type of study.
RequestReturn
object
2 properties 2 required
StudyTransition
object
2 properties 1 required
CreateStudyCompletionCodesItemsActor
string
The actor that can provide this completion code.
BaseStudyStudyLabelsItems
string
CreateStudyProlificIdOption
string
Use 'question' if you will add a question in your survey or experiment asking the participant ID Recommended Use 'urlparameters' if your survey or experiment c…
RangeFilterWeightingsSelectedRangeLower
Studies_DeleteStudy_Response_200
object
Empty response body
BaseStudyCompletionCodesItemsCodeType
string
A name for your code to make it easier to understand its intention. Either use one of the predefined options or any other free text.
RemoveFromParticipantGroupAction
string
Removes participants from specific groups

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prolific-studies-api-openapi.yml Raw ↑

Other APIs Prolific publishes across the network.

Prolific aiTaskBuilder API
AE Profile APIs.io
Prolific bonuses API
AE Profile APIs.io
Prolific credentials API
AE Profile APIs.io
Prolific filters API
AE Profile APIs.io
Prolific filterSets API
AE Profile APIs.io
Prolific invitations API
AE Profile APIs.io
Prolific messages API
AE Profile APIs.io
Prolific participantGroups API
AE Profile APIs.io
Prolific projects API
AE Profile APIs.io
Prolific rewardRecommendations API
AE Profile APIs.io
Prolific submissionFeedbackUpload API
AE Profile APIs.io
Prolific submissions API
AE Profile APIs.io
#Studies
← Back to P APIs
API Details
ID
prolific:prolific-studies-api
Base URL
https://api.prolific.com
Docs
https://docs.prolific.com/documentation/get-started/overview
Provider
Prolific
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=prolific-studies-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/prolific-studies-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Prolific studies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.