List segments | Resend API (unofficial showcase)

3 parameters

limitintegeroptional

The number of segments to return. Must be between 1 and 100.

afterstringoptional

A cursor to return segments that come after the specified item.

beforestringoptional

A cursor to return segments that come before the specified item.

1 status code

200Returns an object containing a `data` array of segments and a `has_more` value indicating whether more results are available.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing segment information.

Error handling

limit must be between 1 and 100 when provided. Use after or before as a cursor to request results relative to a specified item.

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

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

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

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "audience_id": "550e8400-e29b-41d4-a716-446655440000",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Request

Response

Errors