List Customer Groups

GET

/admin/customer-groups

Retrieve a list of customer groups. The customer groups can be filtered by fields such as id. The customer groups can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "customer_groups": [
        {
            "id": "string",
            "name": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "customers": [
                {}
            ]
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search term to filter the customer group's searchable properties.

optional

One of

array[string]

Filter by a customer group's IDs.

name

optional

One of

name

array[string]

Filter by a customer group's name.

customers

optional

One of

customers

array[string]

AdminCustomerInGroupFilters

Filter by the ID of a customer to retrieve its groups.

created_by

optional

One of

created_by

array[string]

Filter by an ID of a user to retrieve the customer groups they created.

$ne

array[string]

optional

Filter by values not equal to this parameter.

Example:

["","",""]

$gt

array[string]

optional

Filter by values greater than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$gte

array[string]

optional

Filter by values greater than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lt

array[string]

optional

Filter by values less than this parameter. Useful for numbers and dates only.

Example:

["","",""]

$lte

array[string]

optional

Filter by values less than or equal to this parameter. Useful for numbers and dates only.

Example:

["","",""]

$like

array[string]

optional

Apply a like filter. Useful for strings only.

Example:

["","",""]

$re

array[string]

optional

Apply a regex filter. Useful for strings only.

Example:

["","",""]

$ilike

array[string]

optional

Apply a case-insensitive like filter. Useful for strings only.

Example:

["","",""]

$fulltext

array[string]

optional

Filter to apply on full-text properties.

Example:

["","",""]

$exists

array[string]

optional

Filter by whether a value for this parameter exists (not null).

Example:

["","",""]

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Example:

["","",""]

$in

array[string]

optional

Filter by values in this array.

Example:

["","",""]

$nin

array[string]

optional

Filter by values not in this array.

Example:

["","",""]

$overlap

array[string]

optional

Filter arrays that have overlapping values with this parameter.

Example:

["","",""]

$contains

array[string]

optional

Filter arrays that contain some of the values of this parameter.

Example:

["","",""]

$contained

array[string]

optional

Filter arrays that contain all values of this parameter.

Example:

["","",""]

$eq

array[string]

optional

Example:

["","",""]

$not

array[string]

optional

Example:

["","",""]

Responses

🟢200OK

application/json

Body

The paginated list of customer groups.

limit

number

limit

required

The maximum number of items retrieved.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items

customer_groups

array[object (AdminCustomerGroup) {6}]

required

The list of customer groups.

string

required

The customer group's ID.

name

string

name

required

The customer group's name.

metadata

object

required

The customer group's metadata, used to store custom key-value pairs.

created_at

string <date-time>

created_at

required

The customer group's creation date.

updated_at

string <date-time>

updated_at

required

The customer group's update date.

customers

array [object]

required

The customer group's customers.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Create Customer Group

Delete a Product Tag