For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
      • GETRetrieve a user
      • POSTCreate a test participant for a researcher
    • Taskflow
    • AI Task Builder
    • Studies
    • Representative sample studies
    • study-collections
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
    • Bonuses
    • Messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API ReferenceUsers

Create a test participant for a researcher

|View as Markdown|Open in Claude|
POST
https://api.prolific.com/api/v1/researchers/participants/
POST
/api/v1/researchers/participants/
$curl -X POST https://api.prolific.com/api/v1/researchers/participants/ \
>     -H "Authorization: Token <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "email": "test.participant2024@prolific.co"
>}'
1{
2  "participant_id": "642f1b2e9a1c4e3f8b7d9a12"
3}
### Overview Creates a test participant with the same details as the researcher and the supplied email. This participant will bypass any fraud checks and on-boarding steps. ### Enabling the feature This endpoint is only enabled for select workspaces and will need enabling before the endpoint can be used. ### Participant Limitations - The participant will be limited to take studies only in the workspaces associated to the researcher and where the feature is enabled. - The participant will not be able to cashout any balance earned from completing studies. ### Usage - The API response contains the participant ID. This can be used in a custom allowlist or participant group to target the participant on studies. This enables the researcher to test the study set up end-to-end. - A randomly generated password is assigned to the participant account. We recommend that you request to reset the password, and use this new password to login to the participant account.
Was this page helpful?
Previous

Retrieve a user

Next

Taskflow

Overview

Creates a test participant with the same details as the researcher and the supplied email. This participant will bypass any fraud checks and on-boarding steps.

Enabling the feature

This endpoint is only enabled for select workspaces and will need enabling before the endpoint can be used.

Participant Limitations

  • The participant will be limited to take studies only in the workspaces associated to the researcher and where the feature is enabled.
  • The participant will not be able to cashout any balance earned from completing studies.

Usage

  • The API response contains the participant ID. This can be used in a custom allowlist or participant group to target the participant on studies. This enables the researcher to test the study set up end-to-end.
  • A randomly generated password is assigned to the participant account. We recommend that you request to reset the password, and use this new password to login to the participant account.

Authentication

AuthorizationToken

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

This endpoint expects an object.
emailstringRequiredformat: "email"
  • The email of the test participant.
  • This cannot be an email that has been registered with Prolific already.

Response

Created
participant_idstringformat: "objectId"
The ID of the test participant

Errors

4XX
Client Request Error