Skip to main content
GET
https://api.resend.com
/
contacts
/
:id
/
segments
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.contacts.segments.list({
  id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
});

{
  "object": "list",
  "data": [
    {
      "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "name": "Registered Users",
      "created_at": "2023-10-06T22:59:55.977Z"
    }
  ],
  "has_more": false
}

​
Path Parameters

Either id or email must be provided.
​
id
string
The Contact ID.
​
email
string
The Contact Email.

Query Parameters

Note that the limit parameter is optional. If you do not provide a limit, all segments will be returned in a single response.
​
limit
number
Number of segments to retrieve.
  • Maximum value: 100
  • Minimum value: 1
​
after
string
The ID after which we'll retrieve more segments (for pagination). This ID will not be included in the returned list. Cannot be used with thebefore parameter.
​
before
string
The ID before which we'll retrieve more segments (for pagination). This ID will not be included in the returned list. Cannot be used with the after parameter.
You can only use either after or before parameter, not both. See our pagination guide for more information.
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.contacts.segments.list({
  id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
});

{
  "object": "list",
  "data": [
    {
      "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "name": "Registered Users",
      "created_at": "2023-10-06T22:59:55.977Z"
    }
  ],
  "has_more": false
}