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

# List all loyalty members

> List all loyalty members



## OpenAPI

````yaml https://openapi.commercengine.io/ce-admin.json get /customers/loyalty-members
openapi: 3.1.0
info:
  title: CE Admin APIs
  version: '1.0'
  summary: Comprehensive admin interface for managing your e-commerce platform
  description: >-
    Complete administrative API suite for Commerce Engine, providing powerful
    tools to manage products, orders, customers, inventory, analytics, and
    system configuration. Designed for administrators and backend integrations
    requiring full platform control.
  license:
    name: All Rights Reserved
    url: https://www.commercengine.io/contact-us
  contact:
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
    name: Support
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/admin
    description: Staging Server
    variables:
      store_id:
        default: store_id
        description: Store ID
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/admin
    description: Prod Server
    variables:
      store_id:
        default: store_id
        description: Store ID
security:
  - Authorization: []
tags:
  - name: Analytics
    description: Analytics
  - name: Catalog
    description: Catalog
  - name: Coupons & promotions
    description: Coupons & promotions
  - name: Customers
    description: Customers
  - name: Filter Options
    description: Filter Options
  - name: Inventories
    description: Inventories
  - name: Marketplace
    description: Marketplace
  - name: Marketplace Catalog
    description: Marketplace Catalog
  - name: Media Gallery
    description: Media Gallery
  - name: Metrics
    description: Metrics
  - name: Orders
    description: Orders
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: POS
    description: POS
  - name: POSAdmin
    description: Admin endpoints to be used as proxy in pos
  - name: Segments
    description: Segments
  - name: Shipping
    description: Shipping
  - name: SSE
    description: SSE
  - name: Store
    description: Store
  - name: Webhooks
    description: Webhooks
paths:
  /customers/loyalty-members:
    parameters: []
    get:
      tags:
        - Customers
      summary: List all loyalty members
      description: List all loyalty members
      operationId: list-loyalty-members
      parameters:
        - $ref: '#/components/parameters/pageLimit'
        - $ref: '#/components/parameters/pageNumber'
        - $ref: '#/components/parameters/sortByOptions'
        - $ref: '#/components/parameters/columnBasedFilters'
        - $ref: '#/components/parameters/searchKeyword'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      loyalty_members:
                        type: array
                        items:
                          $ref: '#/components/schemas/LoyaltyMember'
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                    type: object
components:
  parameters:
    pageLimit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        minimum: 1
      description: no of rows per page
    pageNumber:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: page number of pagination list
    sortByOptions:
      name: sort_by
      in: query
      required: false
      schema:
        description: >-
          json string in format {'field_name':'asc', 'other_field_name':'desc',
          ...}
        type: string
      description: 'JSON string format: {"field1":"asc", "field2":"desc"}'
    columnBasedFilters:
      name: filters
      in: query
      required: false
      schema:
        type: string
        example: >-
          {"condition":"AND","filters":[{"type":"data","field":"status","operator":"equals","value":"success"}]}
      description: JSON object
    searchKeyword:
      name: search
      in: query
      required: false
      schema:
        type: string
      description: search keyword
  schemas:
    LoyaltyMember:
      title: LoyaltyMember
      allOf:
        - type: object
          properties:
            customer_id:
              type: string
            customer_name:
              type: string
        - $ref: '#/components/schemas/CustomerLoyalty'
      x-tags:
        - Customers
    Pagination:
      title: Pagination
      description: pagination metadata structure
      type: object
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        previous_page:
          description: Previous page number
          type:
            - integer
            - 'null'
        limit:
          type: integer
          default: 25
        next_page:
          description: Next page number
          type:
            - integer
            - 'null'
    CustomerLoyalty:
      title: CustomerLoyalty
      type: object
      properties:
        membership_number:
          type: string
        points_earned:
          description: total points earned within the current loyalty program.
          type: integer
        points_redeemed:
          description: total points redeemed within the current loyalty program.
          type: integer
        points_balance:
          description: total points available.
          type: integer
        total_spent:
          description: >-
            The total amount a customer has spent within the current loyalty
            program, excluding taxes, promotional discounts, and redeemed
            loyalty points. This value is used to determine tier eligibility and
            earning points calculation.
          type: integer
        total_orders:
          description: >-
            The total number of completed orders counted in the current loyalty
            program.
          type: integer
        lifetime_spent:
          description: ' The total amount a customer has spent across all time, regardless of loyalty program participation. This includes all completed orders and excludes taxes, promotional discounts, and redeemed points.'
          type: integer
        lifetime_orders:
          description: >-
            The total number of completed orders across all time, regardless of
            loyalty program.
          type: integer
        date_of_join:
          description: ' The date and time when the customer first enrolled in the loyalty program.'
          type: string
          format: date-time
        date_of_assign:
          description: >-
            The date and time when the customer's current loyalty tier or
            program instance was assigned. This may change when tiers are
            upgraded, downgraded, or reassigned.
          type:
            - string
            - 'null'
          format: date-time
        date_of_reset:
          description: ' The date and time when the customer’s current loyalty program cycle will reset, at which points earned, points redeemed, balance points, total spent, total orders will be cleared.'
          type:
            - string
            - 'null'
          format: date-time
        current_tier:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        next_tier:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            total_spent_threshold:
              type:
                - integer
                - 'null'
              minimum: 0
            total_orders_threshold:
              type:
                - integer
                - 'null'
              minimum: 0
        name:
          type: string
        renewal_type:
          type: string
          enum:
            - yearly
            - never
            - custom
        tier_upgrade_criteria:
          type: string
          enum:
            - total-spent
            - total-orders
            - custom
      x-tags:
        - Customers
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````