PRprolific
messages

List broadcasts

Changed on

Lists the broadcasts sent from your account, newest first, each with how many recipients have replied.

Pass workspace_id to list the broadcasts sent from that workspace instead. Pass study_id to only return broadcasts about that study.

Results are paginated. Follow next for the following page, or stop when it is null.

get/api/v1/broadcasts/

Request

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

Query parameters

workspace_idstring

List the broadcasts sent from this workspace instead of your own. You must belong to the workspace.

study_idstring

Only return broadcasts about this study.

limitinteger

Page size. Defaults to 25, capped at 50.

cursorstring

Opaque token from a previous response's next link.

Response

A page of broadcasts

nextstring nullable required

URL of the next page, or null on the last page.

Changes

  • 0eeae21e89feRevision changes
    • warning

      added the new MESSAGES enum value to the // response property for the response status

  • 498c9e20b1ceRevision changes
    • warning

      added the new TYPED_IDS enum value to the // response property for the response status