List suppressions | Resend API (unofficial showcase)

4 parameters

originstringoptional

Filter suppressions by origin: `bounce`, `complaint`, or `manual`.

Allowed:bouncecomplaintmanual

limitintegeroptional

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

afterstringoptional

Return suppressions after this cursor.

beforestringoptional

Return suppressions before this cursor.

1 status code

200Returns an object containing the suppressions in `data`, 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 suppression information.

Error handling

origin must be bounce, complaint, or manual when provided. limit must be between 1 and 100; use after or before to navigate 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.suppressions.list({
  origin: "example",
  limit: 20,
  after: "example",
  before: "example",
});

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "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