Skip to content

Customer Group Detail

Returns a single customer group, including the customersCount that the listing omits.

EndpointMethod
/api/admin/customers/groups/{id}GET

Response Fields

FieldTypeDescription
idintegerGroup ID.
codestringUnique group code.
namestringDisplay name.
isUserDefinedinteger0 (system group) or 1 (user-defined).
customersCountintegerNumber of customers in the group (detail-only — null on listing rows).
createdAt, updatedAtstringTimestamps.

Unknown id → 404.

TIP

For what customer groups are and the system-group rules, see the Customer Groups overview.

Released under the MIT License.