Get all customer groups

Get information about all customer groups in an Ecwid store.

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Query parameters

FieldTypeDescription
offsetnumberOffset from the beginning of the returned items list (for paging)
limitnumberMaximum number of returned items. Maximum allowed value: 1000. Default value: 100

Response

A JSON object of type 'CustomerGroupsSearchResult' with the following fields:

CustomerGroupsSearchResult

FieldTypeDescription
totalnumberThe total number of created customer groups (may differ from the number of returned items)
countnumberThe number of returned items (excluding the default customer group)
offsetnumberOffset from the beginning of the returned items list (for paging)
limitnumberMaximum number of returned items. Maximum allowed value: 1000. Default value: 100
itemsArrayThe items list

CustomerGroupsSearchEntry

FieldTypeDescription
idnumberUnique internal customer group ID
namestringCustomer group name

Errors

In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description

HTTP codes

HTTP StatusMeaning
400Request parameters are malformed
402Store doesn't have access to customer groups feature, it's available on Business plan an higher
415Unsupported content-type: expected application/json or text/json
500Cannot retrieve the customer groups info because of an error on the server

Error response body (optional)

FieldTypeDescription
errorMessagestringError message
Language
Authorization
Query