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

# Get Loyalty Rule Statuses

> Retrieve loyalty rule statuses



## OpenAPI

````yaml /api-reference/openapi.documented.json get /api/loyalty/rule_statuses
openapi: 3.0.2
info:
  title: Snag Solutions - API Docs
  description: >-
    Documentation for Loyalty & Socials APIs. Some endpoints require an API key
    to authenticate. To obtain a key, reach out to the Snag Solutions team at
    support@snagsolutions.io.
  version: '0.1'
servers:
  - url: https://admin.snagsolutions.io/
    description: Production
security: []
paths:
  /api/loyalty/rule_statuses:
    get:
      tags:
        - Loyalty
      summary: Get Loyalty Rule Statuses
      description: Retrieve loyalty rule statuses
      parameters:
        - name: organizationId
          in: query
          description: Unique identifier for the organization
          schema:
            type: string
            format: uuid
            title: Organization ID
            example: 123e4567-e89b-12d3-a456-426614174001
        - name: websiteId
          in: query
          description: Unique identifier for the website
          schema:
            type: string
            format: uuid
            title: Website ID
            example: 123e4567-e89b-12d3-a456-426614174002
        - name: walletAddress
          in: query
          description: Wallet address(es) to filter accounts by
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
                minItems: 1
            title: Wallet Address
            example:
              - '0x1234567890abcdef1234567890abcdef12345678'
        - name: userId
          in: query
          description: User ID(s) to filter accounts by
          schema:
            oneOf:
              - type: string
                format: uuid
              - type: array
                items:
                  type: string
                  format: uuid
                minItems: 1
            title: User ID
            example:
              - 123e4567-e89b-12d3-a456-426614174000
        - name: userGroupId
          in: query
          schema:
            type: string
            format: uuid
        - name: userGroupExternalIdentifier
          in: query
          schema:
            type: string
        - name: loyaltyRuleId
          in: query
          description: >-
            Unique identifier(s) for the loyalty rule(s). Accepts a single ID or
            an array (up to 100); for larger sets, batch requests to avoid URL
            length limits.
          schema:
            oneOf:
              - type: string
                format: uuid
              - type: array
                items:
                  type: string
                  format: uuid
                minItems: 1
                maxItems: 100
            title: Loyalty Rule ID
            example: 123e4567-e89b-12d3-a456-426614174030
        - name: limit
          in: query
          description: Number of items to return
          schema:
            default: 10
            type: number
            maximum: 100
            nullable: true
            title: Limit
            example: 10
        - name: startingAfter
          in: query
          description: Starting after item
          schema:
            type: string
            title: Starting After
            example: 123e4567-e89b-12d3-a456-426614174001
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        websiteId:
                          type: string
                          format: uuid
                        organizationId:
                          type: string
                          format: uuid
                        userId:
                          type: string
                          format: uuid
                        loyaltyRuleId:
                          type: string
                          format: uuid
                        progress:
                          type: number
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - websiteId
                        - organizationId
                        - userId
                        - loyaltyRuleId
                        - progress
                        - createdAt
                        - updatedAt
                  hasNextPage:
                    type: boolean
                required:
                  - data
                  - hasNextPage
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    title: Message
                    description: Error message
                    example: Forbidden, Could not validate api key
                required:
                  - message
                title: Forbidden Response
                description: Schema for forbidden response
                example: Forbidden, Could not validate api key
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````