List broadcasts

Retrieve a list of all broadcasts.

Retrieves a paginated list of all broadcasts.

Methods

List

List() (ListBroadcastsResponse, error)

Lists all broadcasts using the default background context.

ListWithContext

ListWithContext(ctx context.Context) (ListBroadcastsResponse, error)

Lists all broadcasts with a custom context for cancellation and timeout control.

ListWithOptions

ListWithOptions(ctx context.Context, options *ListOptions) (ListBroadcastsResponse, error)

Lists broadcasts with pagination options.

Query Parameters

When using ListWithOptions, you can pass a ListOptions struct with the following fields:

limit · number

The maximum number of broadcasts to return per page.

offset · number

The number of broadcasts to skip before starting to return results.

Response

object · string

The object type, always list.

data · Broadcast[]

An array of broadcast objects.

Show Broadcast properties

object · string

The object type, always broadcast.

id · string

The unique identifier for the broadcast.

name · string

The name of the broadcast.

segment_id · string

The ID of the segment this broadcast is sent to.

from · string

The sender email address.

subject · string

The email subject line.

reply_to · string[]

An array of reply-to email addresses.

html · string

The HTML content of the email.

text · string

The plain text content of the email.

preview_text · string

The preview text that appears in email clients.

status · string

The current status of the broadcast.

created_at · string

ISO 8601 timestamp of when the broadcast was created.

scheduled_at · string

ISO 8601 timestamp of when the broadcast is scheduled to be sent.

sent_at · string

ISO 8601 timestamp of when the broadcast was sent.

has_more · boolean

Indicates whether there are more broadcasts available beyond the current page.

Example

package main

import (
    "fmt"
    "github.com/resend/resend-go/v2"
)

func main() {
    client := resend.NewClient("re_123456789")

    broadcasts, err := client.Broadcasts.List()
    if err != nil {
        panic(err)
    }

    fmt.Println("Total broadcasts:", len(broadcasts.Data))
    for _, broadcast := range broadcasts.Data {
        fmt.Printf("%s: %s (Status: %s)\n", broadcast.Id, broadcast.Name, broadcast.Status)
    }
}

Example with pagination

package main

import (
    "context"
    "fmt"
    "github.com/resend/resend-go/v2"
)

func main() {
    client := resend.NewClient("re_123456789")

    options := &resend.ListOptions{
        Limit:  10,
        Offset: 0,
    }

    broadcasts, err := client.Broadcasts.ListWithOptions(context.Background(), options)
    if err != nil {
        panic(err)
    }

    fmt.Println("Has more:", broadcasts.HasMore)
}