GET
/
admin
/
customer-groups
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customerGroup.list()
.then(({ customer_groups, count, limit, offset }) => {
  console.log(customer_groups)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "customer_groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "customers": [
        {}
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

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

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
q
string

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

​
id

Filter by a customer group's IDs.

​
name

Filter by a customer group's name.

​
customers

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

​
created_by

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

​
created_at
object

Filter the customer group by its creation date.

​
updated_at
object

Filter the customer groups by their update date.

​
deleted_at
object

Filter the customer groups by their deletion date.

​
$and
$and · object[]

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

​
$or
$or · object[]

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

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of customer groups.