# Prolific API ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolific.com/_mcp/server ## Docs - [Welcome to the Prolific API:
Automate human data collection at scale](https://docs.prolific.com/documentation/get-started/overview.md): Use the Prolific API to automate study creation, participant recruitment, and data collection — with built-in participant verification and quality controls. - [Terminology](https://docs.prolific.com/documentation/get-started/terminology.md) - [API Fundamentals](https://docs.prolific.com/documentation/get-started/api-fundamentals.md) - [Your first data collection](https://docs.prolific.com/documentation/get-started/your-first-data-collection.md): Let's set up your first data collection through the Prolific API - create a study, find your participants, and launch it programmatically. - [Finding the right participants](https://docs.prolific.com/documentation/core-concepts/finding-the-right-participants.md) - [Reviewing submissions and rewards](https://docs.prolific.com/documentation/core-concepts/reviewing-submissions-and-rewards.md) - [Testing study set up](https://docs.prolific.com/documentation/core-concepts/testing-study-set-up.md) - [Monitoring study progress](https://docs.prolific.com/documentation/core-concepts/monitoring-study-progress.md) - [Managing high loads](https://docs.prolific.com/documentation/core-concepts/managing-high-loads.md) - [Get Started: Running AI Task Builder Batches via Prolific's API](https://docs.prolific.com/documentation/core-concepts/running-ai-task-builder-batches-via-prolifics-api.md) - [Longitudinal or multi-part studies](https://docs.prolific.com/documentation/cookbooks/longitudinal-or-multi-part-studies.md) - [Collecting original data with AI Task Builder Collections](https://docs.prolific.com/documentation/cookbooks/collecting-original-data-with-ai-task-builder-collections.md) - [Prolific CLI](https://docs.prolific.com/documentation/tooling/prolific-cli.md) - [Introduction](https://docs.prolific.com/api-reference.md) - [Basic](https://docs.prolific.com/api-reference/introduction/basic.md) - [Versioning and stability](https://docs.prolific.com/api-reference/introduction/versioning-and-stability.md) - [Rate limits and API status](https://docs.prolific.com/api-reference/introduction/rate-limits-and-api-status.md) - [Account balance](https://docs.prolific.com/api-reference/introduction/account-balance.md) - [API support](https://docs.prolific.com/api-reference/introduction/api-support.md) - [Users](https://docs.prolific.com/api-reference/users.md) - [Taskflow](https://docs.prolific.com/api-reference/taskflow.md) - [AI Task Builder](https://docs.prolific.com/api-reference/ai-task-builder.md) - [Batches](https://docs.prolific.com/api-reference/ai-task-builder/batches.md) - [Exporting Batch Data](https://docs.prolific.com/api-reference/ai-task-builder/exporting-batch-data.md) - [Collections](https://docs.prolific.com/api-reference/ai-task-builder/collections.md) - [Exporting Collection Data](https://docs.prolific.com/api-reference/ai-task-builder/exporting-collection-data.md) - [Datasets](https://docs.prolific.com/api-reference/ai-task-builder/datasets.md) - [Defining a Dataset Schema](https://docs.prolific.com/api-reference/ai-task-builder/defining-a-dataset-schema.md) - [Uploading Data](https://docs.prolific.com/api-reference/ai-task-builder/uploading-data.md) - [Migrating a Dataset Schema](https://docs.prolific.com/api-reference/ai-task-builder/migrating-a-dataset-schema.md) - [Appending Data](https://docs.prolific.com/api-reference/ai-task-builder/appending-data.md) - [Syncing a Batch](https://docs.prolific.com/api-reference/ai-task-builder/syncing-a-batch.md) - [Setting up a Batch from a Schema Dataset](https://docs.prolific.com/api-reference/ai-task-builder/setting-up-a-batch-from-a-schema-dataset.md) - [Configurable Layout](https://docs.prolific.com/api-reference/ai-task-builder/configurable-layout.md) - [Instructions](https://docs.prolific.com/api-reference/ai-task-builder/instructions.md) - [Studies](https://docs.prolific.com/api-reference/studies.md) - [The study object](https://docs.prolific.com/api-reference/studies/the-study-object.md) - [Representative sample studies](https://docs.prolific.com/api-reference/representative-sample-studies.md) - [Available representative sample study types](https://docs.prolific.com/api-reference/representative-sample-studies/available-representative-sample-study-types.md) - [Filters Overview](https://docs.prolific.com/api-reference/filters/filters-overview.md) - [Advanced filtering](https://docs.prolific.com/api-reference/filters/advanced-filtering.md) - [Study Distribution (Quotas) with Filters](https://docs.prolific.com/api-reference/filters/study-distribution-quotas-with-filters.md) - [Filter Sets](https://docs.prolific.com/api-reference/filter-sets.md) - [Participant Groups](https://docs.prolific.com/api-reference/participant-groups.md) - [Custom Groups](https://docs.prolific.com/api-reference/custom-groups.md) - [Study Distribution](https://docs.prolific.com/api-reference/study-distribution.md) - [Submissions](https://docs.prolific.com/api-reference/submissions.md) - [Submissions guide](https://docs.prolific.com/api-reference/submissions/submissions-guide.md) - [Submission object](https://docs.prolific.com/api-reference/submissions/submission-object.md) - [Uploading submission feedback files](https://docs.prolific.com/api-reference/submission-feedback-upload.md) - [Bonuses](https://docs.prolific.com/api-reference/bonuses.md) - [Messages](https://docs.prolific.com/api-reference/messages.md) - [Workspaces](https://docs.prolific.com/api-reference/workspaces.md) - [Projects](https://docs.prolific.com/api-reference/projects.md) - [Surveys](https://docs.prolific.com/api-reference/surveys.md) - [Webhooks](https://docs.prolific.com/api-reference/webhooks.md) - [Subscribing](https://docs.prolific.com/api-reference/webhooks/subscribing.md) - [Receiving](https://docs.prolific.com/api-reference/webhooks/receiving.md) - [Event Delivery and Retry Logic](https://docs.prolific.com/api-reference/webhooks/event-delivery-and-retry-logic.md) - [Persistent Failures and Disabling Logic](https://docs.prolific.com/api-reference/webhooks/persistent-failures-and-disabling-logic.md) - [Idempotency and the X-Event-ID Header](https://docs.prolific.com/api-reference/webhooks/idempotency-and-the-x-event-id-header.md) - [Handling event order with X-Timestamp](https://docs.prolific.com/api-reference/webhooks/handling-event-order-with-x-timestamp.md) - [Verifying](https://docs.prolific.com/api-reference/webhooks/verifying.md) - [Invitations](https://docs.prolific.com/api-reference/invitations.md) - [Reward Recommendations](https://docs.prolific.com/api-reference/reward-recommendations.md) - [Testing](https://docs.prolific.com/api-reference/testing.md) - [Well-Known Endpoints](https://docs.prolific.com/api-reference/well-known-endpoints.md) ## API Docs - API Reference > Users [Retrieve a user](https://docs.prolific.com/api-reference/users/get-user.md) - API Reference > Users [Create a test participant for a researcher](https://docs.prolific.com/api-reference/users/create-test-participant-for-researcher.md) - API Reference > AI Task Builder [List Batches](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-batches.md) - API Reference > AI Task Builder [Create a Batch](https://docs.prolific.com/api-reference/ai-task-builder/create-task-builder-batch.md) - API Reference > AI Task Builder [Get a Batch](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-batch.md) - API Reference > AI Task Builder [Update a Batch](https://docs.prolific.com/api-reference/ai-task-builder/update-task-builder-batch.md) - API Reference > AI Task Builder [Sync a Batch](https://docs.prolific.com/api-reference/ai-task-builder/sync-task-builder-batch.md) - API Reference > AI Task Builder [Get Batch Sync Status](https://docs.prolific.com/api-reference/ai-task-builder/get-batch-sync-status.md) - API Reference > AI Task Builder [Get Batch Status](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-batch-status.md) - API Reference > AI Task Builder [Setup a Batch](https://docs.prolific.com/api-reference/ai-task-builder/setup-task-builder-batch.md) - API Reference > AI Task Builder [Get Batch Responses](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-batch-task-responses.md) - API Reference > AI Task Builder [Get Batch Report](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-batch-report.md) - API Reference > AI Task Builder [Duplicate a Batch](https://docs.prolific.com/api-reference/ai-task-builder/duplicate-task-builder-batch.md) - API Reference > AI Task Builder [Request a Batch Export](https://docs.prolific.com/api-reference/ai-task-builder/request-batch-export.md) - API Reference > AI Task Builder [Get Batch Export Status](https://docs.prolific.com/api-reference/ai-task-builder/get-batch-export-status.md) - API Reference > AI Task Builder [Create a Dataset](https://docs.prolific.com/api-reference/ai-task-builder/create-task-builder-dataset.md) - API Reference > AI Task Builder [Get a Dataset](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-dataset.md) - API Reference > AI Task Builder [Update a Dataset Schema](https://docs.prolific.com/api-reference/ai-task-builder/update-task-builder-dataset.md) - API Reference > AI Task Builder [Get Dataset Upload URL](https://docs.prolific.com/api-reference/ai-task-builder/get-dataset-upload-url.md) - API Reference > AI Task Builder [Get Dataset Import Status](https://docs.prolific.com/api-reference/ai-task-builder/get-dataset-import-status.md) - API Reference > AI Task Builder [Append Datapoints to a Dataset](https://docs.prolific.com/api-reference/ai-task-builder/append-dataset-datapoints.md) - API Reference > AI Task Builder [Get Schema Migration Status](https://docs.prolific.com/api-reference/ai-task-builder/get-schema-migration-status.md) - API Reference > AI Task Builder [Get Dataset Status](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-dataset-status.md) - API Reference > AI Task Builder [Get Batch Instructions](https://docs.prolific.com/api-reference/ai-task-builder/get-task-builder-instructions.md) - API Reference > AI Task Builder [Create Batch Instructions](https://docs.prolific.com/api-reference/ai-task-builder/create-task-builder-instructions.md) - API Reference > AI Task Builder [Update Batch Instructions](https://docs.prolific.com/api-reference/ai-task-builder/update-task-builder-instructions.md) - API Reference > AI Task Builder [List Collections](https://docs.prolific.com/api-reference/ai-task-builder/list-collections.md) - API Reference > AI Task Builder [Create a Collection](https://docs.prolific.com/api-reference/ai-task-builder/create-collection.md) - API Reference > AI Task Builder [Get a Collection](https://docs.prolific.com/api-reference/ai-task-builder/get-collection.md) - API Reference > AI Task Builder [Update a Collection](https://docs.prolific.com/api-reference/ai-task-builder/update-collection.md) - API Reference > AI Task Builder [Get Collection Responses](https://docs.prolific.com/api-reference/ai-task-builder/get-collection-responses.md) - API Reference > AI Task Builder [Request a Collection Export](https://docs.prolific.com/api-reference/ai-task-builder/request-collection-export.md) - API Reference > AI Task Builder [Get Collection Export Status](https://docs.prolific.com/api-reference/ai-task-builder/get-collection-export-status.md) - API Reference > Studies [List all studies](https://docs.prolific.com/api-reference/studies/get-studies.md) - API Reference > Studies [Create a draft study](https://docs.prolific.com/api-reference/studies/create-study.md) - API Reference > Studies [List all studies in a project](https://docs.prolific.com/api-reference/studies/get-project-studies.md) - API Reference > Studies [Delete a study from a project](https://docs.prolific.com/api-reference/studies/delete-project-study.md) - API Reference > Studies [Retrieve a study](https://docs.prolific.com/api-reference/studies/get-study.md) - API Reference > Studies [Delete a study](https://docs.prolific.com/api-reference/studies/delete-study.md) - API Reference > Studies [Update a study](https://docs.prolific.com/api-reference/studies/update-study.md) - API Reference > Studies [Transition a study's status](https://docs.prolific.com/api-reference/studies/publish-study.md) - API Reference > Studies [Create a test study](https://docs.prolific.com/api-reference/studies/create-test-study.md) - API Reference > Studies [Get taskflow progress](https://docs.prolific.com/api-reference/studies/get-study-access-details-progress.md) - API Reference > Studies [Show Study cost](https://docs.prolific.com/api-reference/studies/get-study-cost.md) - API Reference > Studies [List study submissions](https://docs.prolific.com/api-reference/studies/get-study-submissions.md) - API Reference > Studies [Count study submissions by status](https://docs.prolific.com/api-reference/studies/count-study-submissions-by-status.md) - API Reference > Studies [Download credential usage report](https://docs.prolific.com/api-reference/studies/download-study-credential-report.md) - API Reference > Studies [Download demographic data](https://docs.prolific.com/api-reference/studies/export-study.md) - API Reference > Studies [Export demographic data](https://docs.prolific.com/api-reference/studies/export-demographic-data.md) - API Reference > Studies [Get demographic export history](https://docs.prolific.com/api-reference/studies/get-demographic-export-history.md) - API Reference > Studies [Duplicate a study](https://docs.prolific.com/api-reference/studies/duplicate-study.md) - API Reference > Studies [Show Study predicted recruitment time](https://docs.prolific.com/api-reference/studies/get-study-predicted-recruitment-time.md) - API Reference > Studies [Calculate the study cost](https://docs.prolific.com/api-reference/studies/calculate-study-cost.md) - API Reference > Filters [List all filters](https://docs.prolific.com/api-reference/filters/get-filters.md) - API Reference > Filters [Get filter distribution](https://docs.prolific.com/api-reference/filters/get-filter-distribution.md) - API Reference > Filters [Count participants](https://docs.prolific.com/api-reference/filters/get-eligible-count.md) - API Reference > Filter Sets [List all filter sets](https://docs.prolific.com/api-reference/filter-sets/get-filter-sets.md) - API Reference > Filter Sets [Create filter set](https://docs.prolific.com/api-reference/filter-sets/create-filter-set.md) - API Reference > Filter Sets [Get filter set](https://docs.prolific.com/api-reference/filter-sets/get-filter-set.md) - API Reference > Filter Sets [Delete filter set](https://docs.prolific.com/api-reference/filter-sets/delete-filter-set.md) - API Reference > Filter Sets [Update filter set](https://docs.prolific.com/api-reference/filter-sets/update-filter-set.md) - API Reference > Filter Sets [Clone filter set](https://docs.prolific.com/api-reference/filter-sets/clone-filter-set.md) - API Reference > Filter Sets [Lock filter set for editing](https://docs.prolific.com/api-reference/filter-sets/lock-filter-set.md) - API Reference > Filter Sets [Unlock filter set for editing](https://docs.prolific.com/api-reference/filter-sets/unlock-filter-set.md) - API Reference > Participant Groups [Get a list of all participant groups within a project or workspace](https://docs.prolific.com/api-reference/participant-groups/get-participant-groups.md) - API Reference > Participant Groups [Create a new participant group within a workspace](https://docs.prolific.com/api-reference/participant-groups/create-participant-group.md) - API Reference > Participant Groups [Get a participant group](https://docs.prolific.com/api-reference/participant-groups/get-participant-group.md) - API Reference > Participant Groups [Delete a participant group](https://docs.prolific.com/api-reference/participant-groups/delete-participant-group.md) - API Reference > Participant Groups [Update a participant group](https://docs.prolific.com/api-reference/participant-groups/update-participant-group.md) - API Reference > Participant Groups [Get a list of all participants within a participant group](https://docs.prolific.com/api-reference/participant-groups/get-participant-group-participants.md) - API Reference > Participant Groups [Add participants to a participant group](https://docs.prolific.com/api-reference/participant-groups/add-to-participant-group.md) - API Reference > Participant Groups [Remove participants from a participant group](https://docs.prolific.com/api-reference/participant-groups/remove-from-participant-group.md) - API Reference > Submissions [List submissions](https://docs.prolific.com/api-reference/submissions/get-submissions.md) - API Reference > Submissions [Retrieve a submission](https://docs.prolific.com/api-reference/submissions/get-submission.md) - API Reference > Submissions [Approve or reject a submission](https://docs.prolific.com/api-reference/submissions/transition-submission.md) - API Reference > Submissions [Request the participant who submitted the response to return their response](https://docs.prolific.com/api-reference/submissions/request-submission-return.md) - API Reference > Submissions [Bulk approve submissions](https://docs.prolific.com/api-reference/submissions/bulk-approve-submissions.md) - API Reference > Submission Feedback Upload [Request a feedback upload URL](https://docs.prolific.com/api-reference/submission-feedback-upload/get-submission-feedback-upload-url.md) - API Reference > Bonuses [Set up bonuses](https://docs.prolific.com/api-reference/bonuses/create-bonus-payments.md) - API Reference > Bonuses [Pay bonuses](https://docs.prolific.com/api-reference/bonuses/pay-bonus-payments.md) - API Reference > Messages [Retrieve messages](https://docs.prolific.com/api-reference/messages/get-messages.md) - API Reference > Messages [Send a message](https://docs.prolific.com/api-reference/messages/send-message.md) - API Reference > Messages [Send a message to multiple participants](https://docs.prolific.com/api-reference/messages/bulk-message-participants.md) - API Reference > Messages [Send a message to a participant group](https://docs.prolific.com/api-reference/messages/send-message-to-participant-group.md) - API Reference > Messages [Retrieve unread messages](https://docs.prolific.com/api-reference/messages/get-unread-messages.md) - API Reference > Workspaces [Get all a user's workspaces](https://docs.prolific.com/api-reference/workspaces/get-workspaces.md) - API Reference > Workspaces [Create a workspace](https://docs.prolific.com/api-reference/workspaces/create-workspace.md) - API Reference > Workspaces [Get workspace](https://docs.prolific.com/api-reference/workspaces/get-workspace.md) - API Reference > Workspaces [Update a workspace](https://docs.prolific.com/api-reference/workspaces/update-workspace.md) - API Reference > Workspaces [Get the balance of a workspace](https://docs.prolific.com/api-reference/workspaces/get-workspace-balance.md) - API Reference > Projects [Get all projects in a workspace](https://docs.prolific.com/api-reference/projects/get-projects.md) - API Reference > Projects [Create a project](https://docs.prolific.com/api-reference/projects/create-project.md) - API Reference > Projects [Get project](https://docs.prolific.com/api-reference/projects/get-project.md) - API Reference > Projects [Update a project](https://docs.prolific.com/api-reference/projects/update-project.md) - API Reference > Surveys [Get all surveys](https://docs.prolific.com/api-reference/surveys/get-surveys.md) - API Reference > Surveys [Create survey](https://docs.prolific.com/api-reference/surveys/create-survey.md) - API Reference > Surveys [Get survey](https://docs.prolific.com/api-reference/surveys/get-survey.md) - API Reference > Surveys [Delete survey](https://docs.prolific.com/api-reference/surveys/delete-survey.md) - API Reference > Surveys [Get all responses](https://docs.prolific.com/api-reference/surveys/get-responses.md) - API Reference > Surveys [Create response](https://docs.prolific.com/api-reference/surveys/create-response.md) - API Reference > Surveys [Delete all responses](https://docs.prolific.com/api-reference/surveys/delete-responses.md) - API Reference > Surveys [Get summary of responses](https://docs.prolific.com/api-reference/surveys/get-summary.md) - API Reference > Surveys [Get response](https://docs.prolific.com/api-reference/surveys/get-response.md) - API Reference > Surveys [Delete a response](https://docs.prolific.com/api-reference/surveys/delete-response.md) - API Reference > Webhooks [List all subscribable event types](https://docs.prolific.com/api-reference/webhooks/get-event-types.md) - API Reference > Webhooks [List all secrets](https://docs.prolific.com/api-reference/webhooks/get-secrets.md) - API Reference > Webhooks [Create/replace a secret](https://docs.prolific.com/api-reference/webhooks/create-secret.md) - API Reference > Webhooks [List all subscriptions](https://docs.prolific.com/api-reference/webhooks/get-subscriptions.md) - API Reference > Webhooks [Create a subscription](https://docs.prolific.com/api-reference/webhooks/create-subscription.md) - API Reference > Webhooks [Retrieve a subscription](https://docs.prolific.com/api-reference/webhooks/get-subscription.md) - API Reference > Webhooks [Confirm a subscription](https://docs.prolific.com/api-reference/webhooks/confirm-subscription.md) - API Reference > Webhooks [Delete a subscription](https://docs.prolific.com/api-reference/webhooks/delete-subscription.md) - API Reference > Webhooks [Update a subscription](https://docs.prolific.com/api-reference/webhooks/update-subscription.md) - API Reference > Webhooks [Get subscription events](https://docs.prolific.com/api-reference/webhooks/get-events.md) - API Reference > Invitations [Create a new invitation](https://docs.prolific.com/api-reference/invitations/create-invitation.md) - API Reference > Reward Recommendations [Calculate reward recommendations](https://docs.prolific.com/api-reference/reward-recommendations/calculate-reward-recommendations.md) - API Reference > Well Known Endpoints [Retrieve JSON Web Key Set (JWKS)](https://docs.prolific.com/api-reference/well-known-endpoints/get-study-jwks.md) - API Reference > Credentials [List credential pools for a workspace](https://docs.prolific.com/api-reference/credentials/list-credential-pools.md) - API Reference > Credentials [Create credential pool](https://docs.prolific.com/api-reference/credentials/create-credential-pool.md) - API Reference > Credentials [Update credential pool](https://docs.prolific.com/api-reference/credentials/update-credential-pool.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.prolific.com/openapi.json) - [OpenAPI YAML](https://docs.prolific.com/openapi.yaml)