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.

Documentation API Reference

Documentation API Reference

API Reference

API Reference Participant Groups

Add participants to a participant group

|View as Markdown|Open in Claude|

POST

https://api.prolific.com/api/v1/participant-groups/:id/participants/

POST

/api/v1/participant-groups/:id/participants/

$ curl -X POST https://api.prolific.com/api/v1/participant-groups/id/participants/ \
>      -H "Authorization: Token <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "participant_ids": [
>     "5e9b9c9b0f9c9a0001b0b1f4",
>     "5e9b9c9b0f9c9a0001b0b1f5",
>     "5e9b9c9b0f9c9a0001b0b1f6"
>   ]
> }'

1 {
2   "results": [
3     {
4       "participant_id": "5e9b9c9b0f9c9a0001b0b1f5",
5       "datetime_created": "2020-04-20T12:00:00Z"
6     }
7   ]
8 }

Append participants to a participant group if they are not already members. If a participant is already a member of the group, they will be ignored.

Was this page helpful?

Get a list of all participants within a participant group

Remove participants from a participant group

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>.

Path parameters

idstringRequired

The id of the participant group to add the participant to

Request

This endpoint expects an object.

participant_idslist of stringsOptional

Response

All participant(s) now in participant group

resultslist of objects

Errors

4XX

Client Request Error