---
title: 'Get Loyalty Rule Groups'
description: 'Retrieve configured loyalty rule groups'
openapi: GET /api/loyalty/rule_groups
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://docs.snagsolutions.io/llms.txt). Append `.md` to any page URL for its markdown version.

`GET /api/loyalty/rule_groups` — query parameters: `websiteId`, `organizationId`, `startingAfter`, `limit`, `excludeHidden`

`GET https://admin.snagsolutions.io/api/loyalty/rule_groups`

Retrieve configured loyalty rule groups

## Authentication

- `apiKeyAuth` — apiKey in header: `X-API-KEY`

## Query parameters

- `websiteId` (string)
- `organizationId` (string)
- `startingAfter` (string)
- `limit` (integer)
- `excludeHidden` (string)

## Response 200

200
  - response (object)
    - `data` (array, required)
      - `items` (object) — Schema for a get loyalty rule groups response
        - `id` (string, uuid, required)
        - `name` (string, required)
        - `isRequired` (boolean, required)
        - `sortId` (number, required)
        - `isCollapsible` (boolean, required)
        - `subTitle` (string, required)
        - `loyaltyGroupItems` (array, required)
          - `items` (object)
            - id: … (nested further)
            - sortId: … (nested further)
            - loyaltyRule: … (nested further)
    - `hasNextPage` (boolean, required)

## Response 403

403
  - response (object) — Schema for forbidden response
    - `message` (string, required) — Error message


---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://docs.snagsolutions.io/api-specs.zip
