---
title: "List CustomerSegments"
method: GET
path: "/shop/customers/customer-segments"
tags: ["CustomerSegments"]
---

# List CustomerSegments

`GET /shop/customers/customer-segments`

Returns a paginated list of `CustomerSegment`s for the given site.

## Query parameters

- `site_id` string, uuid, required
- `query` string
- `page` integer
- `per_page` integer

## Response `200`

The customer segments were successfully retrieved.

- object
  - `data` CustomerSegment[], required
    - `id` string, uuid, required — The unique identifier of the customer segment.
    - `name` string, required — The display name of the segment.
    - `site_id` string, uuid, required — The ID of the site this segment belongs to.
    - `filters` object, nullable, required — Optional filters that define automatic membership criteria for this segment. `null` indicates no filters are applied.
      - `all_customers` boolean — When `true`, all customers in the site are included in the segment regardless of other filters.
      - `label_ids` string[], nullable — Customers that have all of the given label IDs are included in the segment.
      - `membership_type_ids` union — Customers that hold a membership matching one of the given IDs are included in the segment. Use `true` to include customers with any active membership.
        - string[], nullable
        - true
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

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