List customer groups

GET

/v2/customers/groups

Retrieves the list of customer groups of a business.

Permissions:CUSTOMERS_READ

Guide

List customer groups

Try in API Explorer

Link to section

Query parameters

Example code

Link to section

cursor

string

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

For more information, see Pagination.

Link to section

limit

integer(32-bit)

The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the limit is less than 1 or greater than 50, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 50.

For more information, see Pagination.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

groups

A list of customer groups belonging to the current seller.

Link to section

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.