List broadcasts | Resend API (unofficial showcase)

3 parameters

limitintegeroptional

Number of broadcasts to return. Must be between 1 and 100.

afterstringoptional

Return broadcasts after this cursor.

beforestringoptional

Return broadcasts before this cursor.

1 status code

200Returns a paginated response containing broadcast records, a `has_more` indicator, and the response object type.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing broadcast information.

Error handling

limit must be between 1 and 100. Use after or before to provide a cursor for navigating the results.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.broadcasts.list({
  limit: 20,
  after: "example",
  before: "example",
});

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

Request

Response

Errors