> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.prolific.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.prolific.com/_mcp/server.

# List broadcasts

GET https://api.prolific.com/api/v1/broadcasts/

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.


Reference: https://docs.prolific.com/api-reference/messages/get-broadcasts

## Authentication

- `Authorization` header (required) (prefixed with ` Token  `) — 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>`.

## Request

### Query parameters

- `workspace_id` (string, optional) — List the broadcasts sent from this workspace instead of your own. You must belong to the workspace.
- `study_id` (string, optional) — Only return broadcasts about this study.
- `limit` (integer, optional) — Page size. Defaults to 25, capped at 50.
- `cursor` (string, optional) — Opaque token from a previous response's `next` link.

## Response

### 200

A page of broadcasts

- `next` (string, required, nullable) — URL of the next page, or null on the last page.
- `results` (list of BroadcastWithReplies, required)

## Errors

### 503 Service Unavailable Error

Message service temporarily unavailable

- `status` (integer, required) — Status code as in the http standards
- `error_code` (integer, required) — Internal error code
- `title` (string, required) — Error title
- `detail` (ErrorDetailDetail, required) — Error detail
- `additional_information` (string, optional) — Optional extra information
- `traceback` (string, optional) — Optional debug information
- `interactive` (boolean, optional)

### 504 Gateway Timeout Error

Message query timed out

- `status` (integer, required) — Status code as in the http standards
- `error_code` (integer, required) — Internal error code
- `title` (string, required) — Error title
- `detail` (ErrorDetailDetail, required) — Error detail
- `additional_information` (string, optional) — Optional extra information
- `traceback` (string, optional) — Optional debug information
- `interactive` (boolean, optional)

### 400 Client Request Error

Error

- `status` (integer, required) — Status code as in the http standards
- `error_code` (integer, required) — Internal error code
- `title` (string, required) — Error title
- `detail` (ErrorDetailDetail, required) — Error detail
- `additional_information` (string, optional) — Optional extra information
- `traceback` (string, optional) — Optional debug information
- `interactive` (boolean, optional)

## Types

### BroadcastWithReplies

- `id` (string, required)
- `study_id` (string, required)
- `subject` (string, required)
- `topic` (string, required, nullable)
- `body` (string, required)
- `audience_source` (enum, required)
  - Allowed values: `submissions`, `PARTICIPANT_GROUP`
- `participant_group` (BroadcastWithRepliesParticipantGroup, required, nullable) — The participant group it was sent to, or null.
- `recipient_count` (integer, required)
- `datetime_created` (datetime, required)
- `replied_count` (integer, required) — How many recipients have replied. Your own follow-ups don't count.

### ErrorDetailDetail

Error detail

- string
- list of string
- ErrorDetailDetail2

### BroadcastWithRepliesParticipantGroup

The participant group it was sent to, or null.

- `id` (string, required)
- `name` (string, required) — The group's name when it was sent.

### ErrorDetailDetail2

All fields with validation errors

- `any_field` (list of string, optional) — Name of the field with a validation error and as a value an array with the error descriptions

## Examples

**Response**

```json
{
  "next": "string",
  "results": [
    {
      "id": "6a0df1a4db9c3b6c71c192a5",
      "study_id": "719e049f7648a4e1f8f3645a",
      "subject": "Wave 2 is open",
      "topic": "other",
      "body": "string",
      "audience_source": "submissions",
      "participant_group": {
        "id": "string",
        "name": "string"
      },
      "recipient_count": 312,
      "datetime_created": "2024-01-15T09:30:00Z",
      "replied_count": 48
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.prolific.com/api/v1/broadcasts/"

headers = {"Authorization": "Token <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.prolific.com/api/v1/broadcasts/';
const options = {method: 'GET', headers: {Authorization: 'Token <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prolific.com/api/v1/broadcasts/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Token <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prolific.com/api/v1/broadcasts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.prolific.com/api/v1/broadcasts/")
  .header("Authorization", "Token <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prolific.com/api/v1/broadcasts/', [
  'headers' => [
    'Authorization' => 'Token <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.prolific.com/api/v1/broadcasts/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Token <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prolific.com/api/v1/broadcasts/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```