List all subscriptions | Prolific API

A view of all subscriptions you have created.

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

Query Parameters

is_enabledbooleanOptional

A filter to only pull back enabled subscriptions. Default true.

workspace_idstringOptional

The Workspace ID we want to get the subscriptions for. If not given, the subscriptions for all of your workspaces will be returned.

Response

List of subscriptions

resultslist of objects

List of all subscriptions.

1	import requests
2
3	url = "https://api.prolific.com/api/v1/hooks/subscriptions/"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"results": [
3	{
4	"event_type": "string",
5	"target_url": "string",
6	"workspace_id": "string",
7	"id": "string",
8	"is_enabled": true
9	}
10	]
11	}

Authentication

Query Parameters

Response

Errors