Skip to navigation
API ReferenceMessages

List broadcasts

View as MarkdownOpen in Claude

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.

Authentication

AuthorizationToken

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

workspace_idstringOptional
List the broadcasts sent from this workspace instead of your own. You must belong to the workspace.
study_idstringOptional
Only return broadcasts about this study.
limitintegerOptional
Page size. Defaults to 25, capped at 50.
cursorstringOptional

Opaque token from a previous response’s next link.

Response

A page of broadcasts
nextstring or null
URL of the next page, or null on the last page.
resultslist of objects

Errors

4XX
Client Request Error
503
Service Unavailable Error
504
Gateway Timeout Error