List Customer Groups

Lists the customer groups customers can be segmented into, returned in the { data, meta } envelope.

Endpoint	Method
/api/admin/customers/groups	GET

Response Fields

Each row in data:

Field	Type	Description
id	integer	Group ID.
code	string	Unique group code.
name	string	Display name.
isUserDefined	integer	0 (system group) or 1 (user-defined).
customersCount	integer | null	Detail-only — null on listing rows.
createdAt, updatedAt	string	Timestamps.

The meta object carries currentPage, perPage, lastPage, total, from, and to.

Query Parameters

Parameter	Type	Description
page, per_page	integer	Pagination (default 10, cap 50).
code	string	Partial code match.
name	string	Partial name match.
is_user_defined	integer	0 (system) or 1 (user-defined).
sort	string	id (default desc), code, name.
order	string	asc, desc.

customersCount is detail-only — null on listing rows.

TIP

For what customer groups are and how they're used, see the Customer Groups overview.