PRprolific
studies

List all studies

Changed on

List all studies, with the option to filter by study status.

get/api/v1/studies/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/studies/
  • Auth
    API key in header Authorization

Query parameters

statusstring

Filter studies by status. Accepts a single status, e.g. "ACTIVE", or multiple statuses in the format "(ACTIVE|PAUSED)". Valid statuses are ACTIVE, PAUSED, UNPUBLISHED, PUBLISHING, COMPLETED, AWAITING REVIEW, UNKNOWN and SCHEDULED.

statestring

Deprecated: use status instead. Accepts a string in the format "(ACTIVE|PAUSED)". Ignored if status is also supplied.

Response

List of studies

Changes

  • 36e3bb40c638Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 5460576856eeRevision changes
    • breaking

      removed the enum value ACTIVE from the query request parameter state

    • breaking

      removed the enum value AWAITING REVIEW from the query request parameter state

    • breaking

      removed the enum value COMPLETED from the query request parameter state

    • breaking

      removed the enum value PAUSED from the query request parameter state

    • breaking

      removed the enum value PUBLISHING from the query request parameter state

    • breaking

      removed the enum value SCHEDULED from the query request parameter state

    • breaking

      removed the enum value UNKNOWN from the query request parameter state

    • breaking

      removed the enum value UNPUBLISHED from the query request parameter state

    • info

      added the new optional query request parameter status

    • info

      query request parameter state was deprecated