List credential pools for a workspace

GET

https://api.prolific.com/api/v1/credentials/

Retrieve a list of credential pools belonging to a specific workspace. Each credential pool summary includes the pool ID, total number of credentials, number of available (unredeemed) credentials, and the workspace ID.

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

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

Query parameters

workspace_idstringRequired

The workspace ID to filter credential pools by

Response

Credential pools retrieved successfully

credential_poolslist of objectsOptional

Errors

400

Bad Request Error

4XX

Client Request Error

403

Forbidden Error

502

Bad Gateway Error

1	{
2	"credential_pools": [
3	{
4	"credential_pool_id": "cred_pool_12345",
5	"total_credentials": 100,
6	"available_credentials": 75
7	},
8	{
9	"credential_pool_id": "cred_pool_67890",
10	"total_credentials": 50,
11	"available_credentials": 50
12	}
13	]
14	}