canonical: https://jentic.com/apis/prolific.com/prolific

# Prolific API for researchers

prolific.com/main version 1.0. The API exposes 78 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get survey, delete survey. Covers 78 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for education only.

## Capabilities

- Get survey
- Delete survey
- Retrieve a user
- Send a message

## Use cases

### Education Operations

Use the Prolific API for researchers to perform education operations programmatically. The API provides 78 endpoints covering core functionality including get survey, delete survey, get response.

Example prompt: Call GET `/api/v1/surveys/{survey_id}` to get survey

### Automated Studies Management

Automate studies operations by combining multiple Prolific API for researchers endpoints. Agents can delete survey and then get response in a single workflow.

Example prompt: Call DELETE `/api/v1/surveys/{survey_id}` to delete survey, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Prolific API for researchers endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get survey', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/surveys/{survey_id}` | Get survey |
| DELETE | `/api/v1/surveys/{survey_id}` | Delete survey |
| GET | `/api/v1/surveys/{survey_id}/responses/{response_id}` | Get response |
| DELETE | `/api/v1/surveys/{survey_id}/responses/{response_id}` | Delete a response |
| GET | `/api/v1/users/me` | Retrieve a user |
| GET | `/api/v1/eligibility-requirements` | Get list of all requirements. |
| POST | `/api/v1/messages` | Send a message |
| GET | `/api/v1/messages` | Retrieve messages |

## Key resources

- **Studies** — To recruit participants for your research, you create a draft study with your audience filters and c
- **Surveys** — Surveys are a way to perform prescreening on the Prolific Platform. You can link a Survey to a Study
- **Hooks** — **This is an experimental feature that may be subject to change in the future.**

Hooks deliver even
- **Filter Sets** — Filter sets allow you to combine multiple filters into a single re-usable template, which can be use
- **Participant Groups** — Participant groups are saved groups of participant IDs, so you can re-contact the exact same
partici

## Why Jentic

- **Setup:** Wiring the Prolific API by hand means setting its API key, targeting api.prolific.com, and mapping surveys, responses, and messages yourself. Through Jentic you install once, import the Prolific API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Prolific puts the survey id in the URL path (`/api/v1/surveys/{survey_id}/responses/{response_id}`), so a rule can pin your agent to a specific survey and its responses. You choose the operations it may call, so a destructive one like deleting a survey or a response is not included unless you add it.
- **Credential handling:** Your Prolific API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a survey' or 'list eligibility requirements', and Jentic returns the matching Prolific operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Complementary API for broader integration workflows
- **Twilio** — Complementary API for broader integration workflows
- **Sendgrid** — Complementary API for broader integration workflows

## FAQ

### What authentication does the Prolific API for researchers use?

The Prolific API for researchers uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get survey with the Prolific API for researchers?

Yes. Use the GET `/api/v1/surveys/{survey_id}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Prolific API for researchers?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get survey through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get survey'. Jentic returns the matching Prolific API for researchers operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Prolific API for researchers have?

The Prolific API for researchers exposes 78 endpoints covering studies, surveys, hooks operations.

### Can I limit what my agent is allowed to do with the Prolific API?

Yes. Because you run Jentic One yourself, your own rules decide which Prolific operations and credentials the agent may use. Prolific puts the survey id in the URL path (for example `/api/v1/surveys/{survey_id}/responses/{response_id}`), so a rule can pin the agent to a single survey and its responses. You also choose the exact operations it may call, so a destructive one like deleting a survey or a response stays out of reach unless you explicitly add it.
