List contacts in a segment | Resend API (unofficial showcase)

4 parameters

idstringrequired

The UUID of the segment whose contacts to list.

limitintegeroptional

The number of contacts to return; must be between 1 and 100.

afterstringoptional

Return contacts after this cursor.

beforestringoptional

Return contacts before this cursor.

1 status code

200Returns a response object containing contact data and a `has_more` flag indicating whether additional results are available.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing contact information.

Error handling

The id path parameter must be a UUID identifying the segment. limit must be an integer between 1 and 100.

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

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

const result = await client.contacts.list({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  limit: 20,
  after: "example",
  before: "example",
});

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "email": "steve.wozniak@gmail.com",
      "first_name": "Steve",
      "last_name": "Wozniak",
      "created_at": "2023-10-06 23:47:56.678+00",
      "unsubscribed": false
    }
  ]
}

Request

Response

Errors