get

/customer_groups

Returns a list of Customer Groups. Default sorting is by customer-group id, from lowest to highest.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

5 Query Parameters
2 Headers

Responses

2 Examples
Schema
array[object]
id
integer

Id of the customer group

1 validation
name
string

Name of the group

1 validation
is_default
boolean

Determines whether new customers are assigned to this group by default.

1 validation
category_access
object
discount_rules
array[object]

A collection of discount rules that are automatically applied to customers who are members of the group

is_group_for_guests
boolean

If the groups is for guests. There can only be one customer group for guests at a time.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client