---
title: "ListCustomerSegments"
method: GET
path: "/v2/customers/segments"
tags: ["CustomerSegments"]
---

# ListCustomerSegments

`GET /v2/customers/segments`

Retrieves the list of customer segments of a business.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

Success

- ListCustomerSegmentsResponse — Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint. Either `errors` or `segments` is present in a given response (never both).
  - `cursor` string — A pagination cursor to be used in subsequent calls to `ListCustomerSegments` to retrieve the next set of query results. The cursor is only present if the request succeeded and additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
  - `errors` Error[] — Any errors that occurred during the request.
    - `category` string, required — The high-level category for the error.
    - `code` string, required — The specific code of the error.
    - `detail` string — A human-readable description of the error for debugging purposes.
    - `field` string — The name of the field provided in the original request (if any) that the error pertains to.
  - `segments` CustomerSegment[] — The list of customer segments belonging to the associated Square account.
    - `created_at` string — The timestamp when the segment was created, in RFC 3339 format.
    - `id` string — A unique Square-generated ID for the segment.
    - `name` string, required — The name of the segment.
    - `updated_at` string — The timestamp when the segment was last updated, in RFC 3339 format.

---

[API](https://skmtc.net/square/apis/squareup.md) · [All operations](https://skmtc.net/square/apis/squareup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/square/squareup/revisions/8d95e3639487/schema)