Basic

View as MarkdownOpen in Claude

The API follows the standard REST approach of

  • URLs entry point is https://api.prolific.com/api/.

  • URLs are versioned https://api.prolific.com/api/v1/endpoints/, so we might do a v2 version in the future.

  • We strongly aim for backward compatibility for the documented endpoints.

There are two URLs per resource and use HTTP methods to operate on resources.

  • A collection URL/api/v1/endpoints/. The collection endpoint is used to retrieve a list of resources (GET) and create a new resource (POST)

  • An element URL/api/v1/endpoints/<id>/. The element URL is used to retrieve a single resource (GET), apply a delta (PATCH), replace existing resource (PUT) and delete (soft or hard) a resource (DELETE).

Optional request header Referer

For example:

If you are providing a library or framework to be used by multiple accounts, sending Referer with your requests can help us identify issues with libraries and we can give a better support for those accounts. Including the version of the library in the referrer url if there are multiple versions is welcomed.

If you are using the API from your app, you can include the Referer with the full url.