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

# List segments

`GET /v1/segments`

## Request

- Base URL: `https://api.volanea.com`
- URL: `https://api.volanea.com/v1/segments`
- Auth: HTTP bearer

Every segment in the project — dynamic and static — with its conditions and cached `memberCount`.

Unpaginated. The count is as of the last refresh, not live: a dynamic segment whose contacts changed since then reports a stale number until `POST /v1/segments/{id}/refresh` recomputes it.

## Response `200`

All segments.

- object
  - `data` Segment[], required
    - `segmentId` string, required
    - `projectId` string
    - `name` string, required
    - `description` string, nullable
    - `type` 'dynamic' | 'static', required: Dynamic segments are computed from `conditions`; static segments are managed via the members endpoints.
    - `conditions` SegmentConditions: Nested condition tree evaluated against contacts, their custom `data`, and their activity.
      - `logic` 'and' | 'or', required
      - `groups` object[], required
        - `filters` object[], required
          - `field` string, required: `email`, `subscribed`, `locale`, `createdAt`, `data.<key>`, `event.<name>`, `email.opened`, …
          - `operator` string, required: `equals`, `notEquals`, `contains`, `notContains`, `greaterThan`, `lessThan`, `exists`, `notExists`, `within`, `notWithin`, `triggered`, `notTriggered`, …
          - `value` union
            - string
            - number
            - boolean
          - `days` integer: Time window (days) for activity operators.
    - `memberCount` integer, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing or invalid API key.

---

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