Skip to navigation
API ReferenceMessages

Get a broadcast

View as MarkdownOpen in Claude

A broadcast as it was sent, with how many recipients have replied. List its conversations with GET /api/v1/conversations and its broadcast_id.

A broadcast that wasn’t sent from your account returns 404. Pass workspace_id for one sent from a workspace you’re in.

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

Path parameters

broadcast_idstringRequired
The broadcast's id, as returned when it was sent.

Query parameters

workspace_idstringOptional
The workspace the broadcast was sent from. You must belong to it.

Response

The broadcast
idstring
study_idstring
subjectstring
topicstring or null
bodystring
audience_sourcestring
recipient_countinteger
datetime_createddatetime
replied_countinteger

How many recipients have replied. Your own follow-ups don’t count.

Errors

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