Get a topic | Resend API (unofficial showcase)

1 parameter

idstringrequired

The ID of the topic to retrieve.

1 status code

200Returns the topic object, including its ID, name, description, default subscription status, visibility, and creation timestamp.

idstringoptional

The ID of the topic.

objectstringoptional

The object type.

namestringoptional

The name of the topic.

descriptionstringoptional

A description of the topic.

default_subscriptionstringoptional

The default subscription status for the topic.

Allowed:opt_inopt_out

visibilitystringoptional

The visibility of the topic.

Allowed:publicprivate

created_atstringoptional

Timestamp indicating when the topic was created.

Error handling

The id path parameter must identify the topic to retrieve.

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

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

const result = await client.topics.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "topic",
  "name": "Newsletter",
  "description": "Example description",
  "default_subscription": "opt_in",
  "visibility": "public",
  "created_at": "2023-10-06 23:47:56.678+00"
}

Request

Response

Errors