Retrieve a list of broadcasts

GET/broadcastsRetrieve a list of broadcasts

Parameters

limitintegerquery

Number of items to return.

maximum 100 · minimum 1

afterstringquery

Return items after this cursor.

beforestringquery

Return items before this cursor.

Responses

objectListBroadcastsResponseSuccess

dataarray of object

Array containing broadcast information.

Show child attributes

Show array items

audience_idstring

Deprecated. Use segment_id instead.

created_atstring · date-time

Timestamp indicating when the broadcast was created.

idstring

Unique identifier for the broadcast.

namestring

Name of the broadcast.

scheduled_atstring · date-time

Timestamp indicating when the broadcast is scheduled to be sent.

segment_idstring

Unique identifier of the segment this broadcast will be sent to.

sent_atstring · date-time

Timestamp indicating when the broadcast was sent.

statusstring

The status of the broadcast.

topic_idstring

The topic ID that the broadcast is scoped to.

has_moreboolean

Indicates if there are more results available.

objectstring

Type of the response object.

Example response

{
  "data": [
    {
      "audience_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "created_at": "2023-10-06T22:59:55.977Z",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "name": "November announcements",
      "scheduled_at": "2023-10-06T22:59:55.977Z",
      "segment_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "sent_at": "2023-10-06T22:59:55.977Z",
      "status": "draft",
      "topic_id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e"
    }
  ],
  "has_more": false,
  "object": "list"
}

Examples

limitquery parameter

afterquery parameter

beforequery parameter

curl -X GET 'https://api.resend.com/broadcasts?after=string&before=string&limit=0'

const response = await fetch('https://api.resend.com/broadcasts?after=string&before=string&limit=0', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.resend.com/broadcasts?after=string&before=string&limit=0', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.resend.com/broadcasts?after=string&before=string&limit=0")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.resend.com/broadcasts?after=string&before=string&limit=0", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/broadcasts?after=string&before=string&limit=0");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/broadcasts?after=string&before=string&limit=0"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/broadcasts?after=string&before=string&limit=0")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.resend.com/broadcasts?after=string&before=string&limit=0");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "audience_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "created_at": "2023-10-06T22:59:55.977Z",
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "name": "November announcements",
      "scheduled_at": "2023-10-06T22:59:55.977Z",
      "segment_id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "sent_at": "2023-10-06T22:59:55.977Z",
      "status": "draft",
      "topic_id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e"
    }
  ],
  "has_more": false,
  "object": "list"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys