Get a suppression by ID or email | Resend API (unofficial showcase)

1 parameter

suppressionstringrequired

The suppression ID or email address to look up.

1 status code

200Returns the suppression object with its ID, email address, origin, source ID, and creation timestamp.

objectstringoptional

Type of the response object.

idstringoptional

Unique identifier for the suppression.

emailstringoptional

Email address that is suppressed.

originstringoptional

Origin of the suppression.

Allowed:bouncecomplaintmanual

source_idstringoptional

Identifier of the event that caused the suppression, such as the email that bounced or complained.

created_atstringoptional

Timestamp indicating when the suppression was created.

Error handling

The suppression path parameter must identify the suppression by its ID or email address.

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

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

const result = await client.suppressions.get({ suppression: "example" });

{
  "object": "suppression",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "email": "steve.wozniak@gmail.com",
  "origin": "manual",
  "source_id": "479e3145-dd38-476b-932c-529ceb705947",
  "created_at": "2023-10-06 23:47:56.678+00"
}

Request

Response

Errors