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

# List segments

`GET /v1/customers/segments`

Retrieve all customer segments.

## Query parameters

- `take` number, nullable
- `skip` number, nullable

## Response `200`

- PaginatedSegment
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` object[], required — List of Segment.
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `rules` object[], required
      - `id` string, required
      - `operator` 'and' | 'or', required
      - `conditions` union[], required
        - union
          - object
            - `field` 'country', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'currency', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'language', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'invoicing_entity_id', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'tax_id', required
            - `operator` 'set' | 'not_set', required
          - object
            - `field` 'external_id', required
            - `operator` 'set' | 'not_set', required
          - object
            - `field` 'payment_method_type', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'payment_method_status', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'relationship', required
            - `operator` 'in' | 'not_in', required
            - `value` string[]
          - object
            - `field` 'customer_id', required
            - `operator` 'in' | 'not_in', required
            - `value` string[]
          - object
            - `field` 'subscription_status', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'product_id', required
            - `operator` 'in' | 'not_in', required
            - `value` string[]
          - object
            - `field` 'invoice_status', required
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` string[]
          - object
            - `field` 'smart_segment.payment_risk', required
            - `operator` 'in', required
          - object
            - `field` 'paid_invoice_count' | 'paid_late_invoice_count' | 'late_payment_rate' | 'average_late_payment_delay_days', required
            - `operator` 'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'between', required
            - `value` number[]
          - object
            - `field` 'contract_end_date' | 'current_subscription_start_date' | 'first_subscription_start_date' | 'customer_created_at', required
            - `operator` 'after' | 'before' | 'between', required
            - `value` string[]
          - object
            - `field` string, required — custom_property.<slug>
            - `operator` 'in' | 'not_in' | 'set' | 'not_set', required
            - `value` union[]
              - …
    - `created_at` string, date, required
    - `updated_at` string, date, required

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)