Retrieve a subscription

View as MarkdownOpen in Claude
Get a single subscription

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

Path Parameters

subscription_idstringRequired
Subscription id

Response

Retrieved
event_typestring
The name of the event type associated to the subscription.
target_urlstring
The URL that the subscription will notify when your event type is triggered.
workspace_idstring
The ID of the workspace we will create the subscription in.
idstring or null
The ID of the subscription.
is_enabledboolean or null
Whether the subscription is enabled or not.

Errors