Open Loyalty

Open Loyalty Earning Rules API

Rules that define how members earn points.

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/open-loyalty-earning-rules-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Open Loyalty REST Authorization Earning Rules API
  version: '1.0'
  description: API-first, headless loyalty and gamification platform. This document models a representative, grounded subset of the Open Loyalty REST API across members (customers), transactions, points transfers, reward campaigns, levels (tiers), and earning rules. Endpoints are scoped per store using a storeCode path segment. Open Loyalty is delivered as managed cloud SaaS on a per-tenant instance, so the server host below is a template - substitute your own Open Loyalty instance host. Requests and responses are JSON over HTTPS, authenticated with a JWT bearer token or a permanent API token.
  contact:
    name: Open Loyalty
    url: https://www.openloyalty.io
  license:
    name: Open Loyalty (Open Source Edition Apache-2.0 / Enterprise SaaS)
    url: https://github.com/OpenLoyalty
servers:
- url: https://{instance}.openloyalty.io/api
  description: Per-tenant Open Loyalty instance (substitute your own host).
  variables:
    instance:
      default: your-instance
      description: Your Open Loyalty tenant subdomain.
security:
- bearerAuth: []
- permanentToken: []
tags:
- name: Earning Rules
  description: Rules that define how members earn points.
paths:
  /{storeCode}/earningRule:
    get:
      operationId: listEarningRules
      tags:
      - Earning Rules
      summary: List earning rules
      parameters:
      - $ref: '#/components/parameters/StoreCode'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: A paginated list of earning rules.
    post:
      operationId: createEarningRule
      tags:
      - Earning Rules
      summary: Create an earning rule
      parameters:
      - $ref: '#/components/parameters/StoreCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EarningRule'
      responses:
        '200':
          description: Earning rule created.
  /{storeCode}/earningRule/{earningRule}:
    get:
      operationId: getEarningRule
      tags:
      - Earning Rules
      summary: Get an earning rule
      parameters:
      - $ref: '#/components/parameters/StoreCode'
      - name: earningRule
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The earning rule.
    put:
      operationId: updateEarningRule
      tags:
      - Earning Rules
      summary: Update an earning rule
      parameters:
      - $ref: '#/components/parameters/StoreCode'
      - name: earningRule
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EarningRule'
      responses:
        '200':
          description: Earning rule updated.
  /{storeCode}/earningRule/{earningRule}/activate:
    post:
      operationId: activateEarningRule
      tags:
      - Earning Rules
      summary: Activate or deactivate an earning rule
      parameters:
      - $ref: '#/components/parameters/StoreCode'
      - name: earningRule
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Earning rule activation state changed.
components:
  parameters:
    PerPage:
      name: perPage
      in: query
      schema:
        type: integer
        default: 10
    StoreCode:
      name: storeCode
      in: path
      required: true
      description: The store the request is scoped to.
      schema:
        type: string
        default: DEFAULT
    Page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
  schemas:
    EarningRule:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
          description: Rule type - points, event, multiply_points, qrcode, geolocation, etc.
        pointsAmount:
          type: number
        active:
          type: boolean
        startAt:
          type: string
          format: date-time
        endAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT obtained from POST /admin/login_check (admin) or POST /{storeCode}/customer/login_check (member), sent as Authorization: Bearer <token>.'
    permanentToken:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
      description: Permanent API token issued to an admin account.
externalDocs:
  description: Open Loyalty REST API reference
  url: https://docs.openloyalty.io/en/latest/api/