> ## Documentation Index
> Fetch the complete documentation index at: https://developer.lulacommerce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List Of Modifier Groups

> This endpoint retrieves a list of all modifier groups for a specific store, with options for filtering, searching, and pagination.

This endpoint returns a comprehensive list of modifier groups configured for your store. You can filter by status, search by name, and control the ordering of results to find specific modifier groups quickly.

<Info>
  This endpoint provides an overview of all your customization options, helping you manage and organize your menu modifiers effectively.
</Info>

### Path Parameters

<ParamField path="store_id" type="string" required>
  The unique identifier of the store
</ParamField>

### Query Parameters

<ParamField query="offset" type="number" default={0}>
  Number of records to skip for pagination
</ParamField>

<ParamField query="search_string" type="string">
  Search term to filter modifier groups by name
</ParamField>

<ParamField query="order" type="string" default="ASC">
  Sort order for results. Values: "ASC" or "DESC"
</ParamField>

<ParamField query="status" type="string">
  Filter by modifier group status. Values: "active" or "inactive"
</ParamField>

### Response

<ResponseField name="modifier_groups" type="array">
  Array of modifier group objects

  <Expandable title="Modifier Group Object">
    <ResponseField name="id" type="string">
      Unique identifier for the modifier group
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the modifier group
    </ResponseField>

    <ResponseField name="min_quantity" type="number">
      Minimum number of options customer must select
    </ResponseField>

    <ResponseField name="max_quantity" type="number">
      Maximum number of options customer can select
    </ResponseField>

    <ResponseField name="precedence" type="number">
      Display order precedence
    </ResponseField>

    <ResponseField name="option_type" type="string">
      Type of options in this group
    </ResponseField>

    <ResponseField name="max_free_options" type="number">
      Maximum number of free options allowed
    </ResponseField>

    <ResponseField name="max_options_qty" type="number">
      Maximum quantity for each option
    </ResponseField>

    <ResponseField name="status" type="string">
      Current status of the modifier group
    </ResponseField>

    <ResponseField name="linked_options" type="string">
      Comma-separated list of linked option names
    </ResponseField>

    <ResponseField name="linked_items" type="string">
      Comma-separated list of linked item names
    </ResponseField>
  </Expandable>
</ResponseField>

### Response Example

```json theme={null}
[
  {
    "id": "1000054",
    "name": "Choose your Sandwich Type",
    "min_quantity": 1,
    "max_quantity": 1,
    "precedence": 0,
    "option_type": "Customization",
    "max_free_options": 0,
    "max_options_qty": null,
    "status": "active",
    "linked_options": "Small,Large,Wrap",
    "linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
  },
  {
    "id": "1000055",
    "name": "Choice of Meat",
    "min_quantity": 1,
    "max_quantity": 1,
    "precedence": 0,
    "option_type": "Customization",
    "max_free_options": 0,
    "max_options_qty": null,
    "status": "active",
    "linked_options": "Egg Salad,Roast Beef,Honey Ham,Turkey,Salami,Crandberry Walnut Chicken Salad,In-Store Made Chicken Salad,Buffalo Style Chicken Salad,Tuna Salad",
    "linked_items": "Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich,Build Your Own Sandwich"
  }
]
```

<Tip>
  Use the search\_string parameter to quickly find specific modifier groups by name. The status filter helps you view only active or inactive groups.
</Tip>

<Note>
  The linked\_options and linked\_items fields provide a quick overview of what's connected to each modifier group without needing additional API calls.
</Note>
