---
title: "List segments"
method: GET
path: "/api/v1/segments"
tags: ["Segments"]
---

# List segments

`GET /api/v1/segments`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/segments`
- 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 list of segments, newest first. Pass the previous response's `next_cursor` as `after` to page forward; `has_more` is false and `next_cursor` is null on the last page.

`member_count` is materialized on each segment, so listing segments never fans out into one count per segment — it is refreshed as membership changes rather than computed on read.

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

## Query parameters

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

## Response `200`

Segment list

- SegmentV1List: Cursor-paginated list of segments.
  - `data` SegmentV1[], required
    - `condition` FilterConditionV1, required: A filter condition: one or more groups combined with `logic`.
      - `groups` FilterGroupV1[], required
        - `conditions` FilterConditionV1 (recursive)
        - `filters` SegmentFilterV1[], required
          - `field` string, required
          - `operator` 'equals' | 'notEquals' | 'contains' | 'notContains' | 'greaterThan' | 'lessThan' | 'greaterThanOrEqual' | 'lessThanOrEqual' | 'exists' | 'notExists' | 'within' | 'olderThan' | 'triggered' | 'triggeredWithin' | 'triggeredOlderThan' | 'notTriggered' | 'notTriggeredWithin' | 'isMemberOf', required
          - `unit` 'days' | 'hours' | 'minutes'
          - `value` unknown
      - `logic` 'AND' | 'OR', required
    - `created_at` string, date-time, required
    - `description` string, nullable, required
    - `id` string, uuid, required
    - `member_count` integer, required
    - `name` string, required
    - `track_membership` boolean, required
    - `type` 'DYNAMIC' | 'STATIC', required
    - `updated_at` string, date-time, 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`.
- `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)
