---
title: "List modifier groups"
method: GET
path: "/v1/modifier_groups/"
tags: ["Modifier Groups"]
---

# List modifier groups

`GET /v1/modifier_groups/`

List modifier groups

**Required scope: `business/catalogue:read`**

## Query parameters

- `cursor` string, nullable — A pagination cursor from where results should start being fetched.
- `limit` integer — The maximum number of results to return.
- `created_at__gte` string, date-time, nullable — The min modifier group created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.
- `created_at__lte` string, date-time, nullable — The max modifier group created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, the range may not exceed 31 days.

## Response `200`

Successful Response

- PaginatedResponseModifierGroup
  - `data` ModifierGroup[], required — A list of paginated entities.
    - `id` string, required — The unique identifier of the modifier group.
    - `name` string, required — The name of the modifier group.
    - `min_selections` integer, required — The minimum number of modifiers that must be selected from the group. A value of `0` means the group is optional.
    - `max_selections` integer, nullable, required — The maximum number of modifiers that may be selected from the group. A value of `null` means there is no maximum.
    - `modifiers` Modifier[] — The modifiers that belong to this group.
      - `id` string, required — The unique identifier of the modifier.
      - `modifier_group_id` string, required — The unique identifier of the modifier group this modifier belongs to.
      - `type` 'note' | 'product', required — `ModifierType` distinguishes between a note-style modifier and product-style modifier. A note-style modifier attaches a text instruction, such as "medium-rare"; where as a product-style modifier attaches an additional variant to the item that may or may not impact the price.
      - `name` string, required — The display name of the modifier.
      - `pricing_strategy` 'fixed_price' | 'free' | 'product', required — `PricingStrategy` determines how the price of a modifier is calculated when applied to an item. - `free` — the modifier does not change the price of the item. - `fixed_price` — the modifier applies the price set in `fixed_price`. - `product` — the modifier inherits the price of its linked variant (`variant_id`).
      - `fixed_price` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
        - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
        - `currency` string, required — The currency code in ISO 4217 format.
      - `is_selected_by_default` boolean, required — Whether the modifier is selected by default when its group is shown to the customer.
      - `ordinal` integer, required — The display ordering of the modifier within its group. Lower values appear first.
      - `variant_id` string, nullable, required — The unique identifier of the variant linked to this modifier. Populated only when `type` is `product`.
    - `created_at` string, date-time, required — The modifier group creation date and time in ISO 8601 format.
  - `next_cursor` string, nullable, required — A pagination cursor that can be used to retrieve the next set of results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/yoco/apis/yoco-api.md) · [All operations](https://skmtc.net/yoco/apis/yoco-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yoco/yoco-api/revisions/1ee03e82bc45/schema)