Skip to main content
Resend Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

List Contact Segments

Retrieve a list of segments that a contact is part of.

Either id or email must be provided.

  • id (string) — The Contact ID.

  • email (string) — The Contact Email.

<>

  {isRequired ? 
  • limit (number) — Number of segments to retrieve.

    • Default value: 20

    • Maximum value: 100

    • Minimum value: 1

: <>

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 the before 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.

      </>

Node.js
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.contacts.segments.list({
  contactId: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
});
PHP
$resend = Resend::client('re_xxxxxxxxx');

$resend->contacts->segments->list(
  contactId: 'e169aa45-1ecf-4183-9955-b1499d5701d3'
);
Python
import resend

resend.api_key = 're_xxxxxxxxx'

params: resend.Contacts.Segments.ListParams = {
    "contact_id": 'e169aa45-1ecf-4183-9955-b1499d5701d3',
}

segments = resend.Contacts.Segments.list(params)
Ruby
require 'resend'

Resend.api_key = 're_xxxxxxxxx'

segments = Resend::Contacts::Segments.list(
  contact_id: 'e169aa45-1ecf-4183-9955-b1499d5701d3'
)
Go
package main

import "github.com/resend/resend-go/v4"

func main() {
	client := resend.NewClient("re_xxxxxxxxx")

	listParams := &resend.ListContactSegmentsRequest{
		ContactId: "479e3145-dd38-476b-932c-529ceb705947",
	}

	client.Contacts.Segments.List(listParams)
}
Rust
use resend_rs::{Resend, Result, list_opts::ListOptions};

#[tokio::main]
async fn main() -> Result<()> {
  let resend = Resend::new("re_xxxxxxxxx");

  let _contacts = resend
    .contacts
    .list_contact_segment(
      "e169aa45-1ecf-4183-9955-b1499d5701d3",
      ListOptions::default()
    )
    .await?;

  Ok(())
}
Java
import com.resend.Resend;
import com.resend.core.exception.ResendException;

public class Main {
  public static void main(String[] args) throws ResendException {
    Resend resend = new Resend("re_xxxxxxxxx");

    resend.contacts().segments().list("e169aa45-1ecf-4183-9955-b1499d5701d3");
  }
}
.NET
using Resend;

IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI

var resp = await resend.ContactListSegmentsAsync( new Guid( "e169aa45-1ecf-4183-9955-b1499d5701d3" ));
Console.WriteLine( "Nr Segments={0}", resp.Content.Data.Count );
cURL
curl -X GET 'https://api.resend.com/contacts/e169aa45-1ecf-4183-9955-b1499d5701d3/segments' \
     -H 'Authorization: Bearer re_xxxxxxxxx'
CLI
resend contacts segments e169aa45-1ecf-4183-9955-b1499d5701d3
Response
{
  "object": "list",
  "data": [
    {
      "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
      "name": "Registered Users",
      "created_at": "2026-10-06 22:59:55.977+00"
    }
  ],
  "has_more": false
}
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu