---
title: "ListCustomerGroups"
method: GET
path: "/v2/customers/groups"
tags: ["CustomerGroups"]
---

# ListCustomerGroups

`GET /v2/customers/groups`

Retrieves the list of customer groups of a business.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

Success

- ListCustomerGroupsResponse — Defines the fields that are included in the response body of a request to the [ListCustomerGroups](https://developer.squareup.com/reference/square_2021-08-18/customer-groups-api/list-customer-groups) endpoint. Either `errors` or `groups` is present in a given response (never both).
  - `cursor` string — A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only 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.
  - `groups` CustomerGroup[] — A list of customer groups belonging to the current seller.
    - `created_at` string — The timestamp when the customer group was created, in RFC 3339 format.
    - `id` string — A unique Square-generated ID for the customer group.
    - `name` string, required — The name of the customer group.
    - `updated_at` string — The timestamp when the customer group 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)