Retrieve a single broadcast

GET/broadcasts/{id}Retrieve a single broadcast

Parameters

idstringpathrequired

The Broadcast ID.

Responses

objectGetBroadcastResponseSuccess

audience_idnull | string

Deprecated: use `segment_id` instead. Unique identifier of the segment this broadcast will be sent to.

created_atstring · date-time

Timestamp indicating when the broadcast was created.

fromstring

The email address of the sender.

htmlnull | string

The HTML version of the broadcast content.

idstring

Unique identifier for the broadcast.

namestring

Name of the broadcast.

preview_textstring

The preview text of the email.

reply_toarray of string

The email addresses to which replies should be sent.

Show child attributes

scheduled_atstring · date-time

Timestamp indicating when the broadcast is scheduled to be sent.

segment_idnull | string

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.

subjectstring

The subject line of the email.

textnull | string

The plain text version of the broadcast content.

topic_idnull | string

The topic ID that the broadcast is scoped to.

Example response

{
  "audience_id": "string",
  "created_at": "2023-10-06T22:59:55.977Z",
  "from": "Acme <onboarding@resend.dev>",
  "html": "<p>Hello {{{FIRST_NAME|there}}}!</p>",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "name": "November announcements",
  "preview_text": "Here are our announcements",
  "reply_to": [
    "string"
  ],
  "scheduled_at": "2023-10-06T22:59:55.977Z",
  "segment_id": "string",
  "sent_at": "2023-10-06T22:59:55.977Z",
  "status": "draft",
  "subject": "Hello World",
  "text": "Hello {{{FIRST_NAME|there}}}!",
  "topic_id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e"
}

Examples

idrequiredpath parameter

curl -X GET 'https://api.resend.com/broadcasts/string'

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

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

import requests

response = requests.request("GET", "https://api.resend.com/broadcasts/string")
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/string", 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/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/broadcasts/string"))
    .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/string")
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/string");
using var response = await client.SendAsync(request);

{
  "audience_id": "string",
  "created_at": "2023-10-06T22:59:55.977Z",
  "from": "Acme <onboarding@resend.dev>",
  "html": "<p>Hello {{{FIRST_NAME|there}}}!</p>",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "name": "November announcements",
  "preview_text": "Here are our announcements",
  "reply_to": [
    "string"
  ],
  "scheduled_at": "2023-10-06T22:59:55.977Z",
  "segment_id": "string",
  "sent_at": "2023-10-06T22:59:55.977Z",
  "status": "draft",
  "subject": "Hello World",
  "text": "Hello {{{FIRST_NAME|there}}}!",
  "topic_id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys