• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List customer groups BETA

Retrieves the list of customer groups of a business.

Required permissions: CUSTOMERS_READ

Query Parameters

Name Description
cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See the Pagination guide for more information.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

groups
CustomerGroup [ ]

A list of customer groups belonging to the current merchant.

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.

See the Pagination guide for more information.

Examples

You are viewing an old version of the API
GET /v2/customers/groups
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/customers/groups \
  -H 'Square-Version: 2020-06-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "groups": [
    {
      "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
      "name": "Loyal Customers",
      "created_at": "2020-04-13T21:54:57.863Z",
      "updated_at": "2020-04-13T21:54:58Z"
    },
    {
      "id": "4XMEHESXJBNE9S9JAKZD2FGB14",
      "name": "Super Loyal Customers",
      "created_at": "2020-04-13T21:55:18.795Z",
      "updated_at": "2020-04-13T21:55:19Z"
    }
  ]
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?