Create credential pool

Create a new workspace-level credential pool. Credential pools contain username/password pairs that can be assigned to participants when they start a study. This allows researchers to provide pre-provisioned credentials for third-party platforms. The credentials are provided as a CSV string where each line contains a username and password separated by a comma (e.g., “user1,pass1\nuser2,pass2”).

Authentication

Authorizationstring

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

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.

credentialsstringRequired

CSV-formatted credentials (username,password per line)

workspace_idstringRequired

The ID of the workspace this credential pool belongs to

Response

Credential pool created successfully

credential_pool_idstring or null

The unique identifier for the created credential pool

1	import requests
2
3	url = "https://api.prolific.com/api/v1/credentials/"
4
5	payload = {
6	"credentials": "user1,password1
7	user2,password2
8	user3,password3",
9	"workspace_id": "507f1f77bcf86cd799439011"
10	}
11	headers = {
12	"Authorization": "<apiKey>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

Authentication

Headers

Request

Response

Errors