---
title: "List the contacts in a segment"
method: GET
path: "/api/v1/segments/{id}/contacts"
tags: ["Segments"]
---

# List the contacts in a segment

`GET /api/v1/segments/{id}/contacts`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/segments/{id}/contacts`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `segments:read`)

Cursor-paginated members of a segment. For a `STATIC` segment these are the rows of its membership list; for a `DYNAMIC` one the saved `condition` is evaluated against contacts as the page is read, so the result always reflects the contacts as they are now.

Cursors from this endpoint are not interchangeable with cursors from other list endpoints — the ordering differs — and pairing one with the wrong endpoint answers 422 rather than silently paging a different set.

Requires the `segments:read` scope — View your segments and who belongs to them.

## Path parameters

- `id` string, uuid, required: Resource id.

## Query parameters

- `limit` integer
- `after` string: Opaque cursor from a previous response's `next_cursor`.

## Response `200`

Segment member list

- SegmentContactV1List: Cursor-paginated list of the contacts belonging to a segment.
  - `data` SegmentContactV1[], required
    - `created_at` string, date-time, required
    - `custom_fields` object, required: Arbitrary JSON value (string, number, boolean, null, array, or object).
    - `email` string, required
    - `id` string, uuid, required
    - `subscribed` boolean, required
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required: Pass as `after` to fetch the next page. `null` on the last page.

## Other responses

- `401`: `invalid_api_key` or `invalid_session` — missing or invalid credentials.
- `403`: `scope_missing`, `project_access_denied`, or `project_disabled`.
- `404`: `resource_not_found` — no segment with this id belongs to the authenticated project.
- `422`: `validation_error` — query, path, or body parameters did not match the schema.
- `429`: `rate_limited` — see `Retry-After` and the `RateLimit` headers.
- `500`: `internal_error`.

---

[API](https://skmtc.dev/sendly/apis/sendly-api.md) · [All operations](https://skmtc.dev/sendly/apis/sendly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sendly/apis/sendly-api/revisions/ce7cfb7f7c7e?raw)
