---
title: "Get all modifier groups"
method: GET
path: "/v3/merchants/{mId}/modifier_groups"
tags: ["INVENTORY"]
---

# Get all modifier groups

`GET /v3/merchants/{mId}/modifier_groups`

Retrieves all modifier groups. Modifier groupings are the categories to which different modifiers belong. Modifier groups can be made available for specific inventory Items by creating an item to a modifier group association.

## Path parameters

- `mId` string, required

## Query parameters

- `filter` string
- `expand` string
- `offset` integer
- `limit` integer

## Headers

- `User-Agent` string, required

## Response `200`

Successful response. Displays all modifier groups.

- object
  - `id` string — Unique identifier of the modifier group.
  - `name` string — Modifier group name.
  - `alternateName` string — Alternate name of the modifier group.
  - `minRequired` integer — Minimum number of modifiers from this group that must be applied to associated lineItems when using the Register app.
  - `maxAllowed` integer — Maximum number of modifiers from this group that can be applied to associated lineItems when using the Register app.
  - `showByDefault` boolean — Indicates whether employees are automatically prompted to add modifiers from this category when using the Register app.
  - `modifiers` object[]
    - `id` string — Unique identifier of the modifier.
    - `name` string — Name of the modifier.
    - `alternateName` string — Alternate name of the modifier.
    - `available` boolean — Indicates whether the modifier is available across all channels.
    - `price` integer — Additional cost associated with using the modifier.
    - `modifierGroup` object
      - `id` string — Unique identifier of the modifier group.
  - `modifierIds` string — Read-only. Comma-separated list of sorted modifier IDs in the modifier group.
  - `items` object[]
    - `id` string — Unique identifier of an item.
  - `sortOrder` integer — Sort order of the modifier group.

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/versions/08da265101a3/schema)