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

# List loyalty members

> Returns one page of the loyalty member directory: who is enrolled, their tier label, redeemable `balance` and monotonic `lifetimePoints`. Use it to browse or to find a member id; when you already hold a CUSTOMER id and want the live balance, call `getLoyaltyAccount` instead — that one recomputes from the ledger. Filter with `tier` (e.g. `Or`) and `status` (`active` / `suspended`), order with `sortField` (`customerName` / `lifetimePoints`), and walk with `page`/`pageSize` (max 100).



## OpenAPI

````yaml /openapi.json get /v1/loyalty
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/loyalty:
    get:
      tags:
        - Loyalty
      summary: List loyalty members
      description: >-
        Returns one page of the loyalty member directory: who is enrolled, their
        tier label, redeemable `balance` and monotonic `lifetimePoints`. Use it
        to browse or to find a member id; when you already hold a CUSTOMER id
        and want the live balance, call `getLoyaltyAccount` instead — that one
        recomputes from the ledger. Filter with `tier` (e.g. `Or`) and `status`
        (`active` / `suspended`), order with `sortField` (`customerName` /
        `lifetimePoints`), and walk with `page`/`pageSize` (max 100).
      operationId: listLoyaltyMembers
      parameters:
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 9007199254740991
          in: query
          name: page
          required: false
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 100
          in: query
          name: pageSize
          required: false
        - schema:
            type: string
            minLength: 1
          in: query
          name: tier
          required: false
        - schema:
            type: string
            minLength: 1
          in: query
          name: status
          required: false
        - schema:
            type: string
            enum:
              - customerName
              - lifetimePoints
          in: query
          name: sortField
          required: false
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDirection
          required: false
      responses:
        '200':
          description: A page of loyalty members with the pagination totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        customerName:
                          type: string
                          minLength: 1
                        tier:
                          type: string
                          minLength: 1
                        balance:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        lifetimePoints:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        status:
                          type: string
                          minLength: 1
                      required:
                        - id
                        - customerName
                        - tier
                        - balance
                        - lifetimePoints
                        - status
                      additionalProperties: false
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  page:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageSize:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pageCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                required:
                  - items
                  - total
                  - page
                  - pageSize
                  - pageCount
                additionalProperties: false
                description: A page of loyalty members with the pagination totals.
                example:
                  items:
                    - id: lm-camille
                      customerName: Camille Renard
                      tier: Or
                      balance: 1240
                      lifetimePoints: 1820
                      status: active
                  total: 8
                  page: 1
                  pageSize: 20
                  pageCount: 1
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````