How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Open Loyalty Members API

Loyalty members (customers).

Open Loyalty Members API is one of 7 APIs that Open Loyalty publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Members. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{instance}.openloyalty.io/api.

7 operations 6 paths 2 schemas 4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://your-instance.openloyalty.io/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Open Loyalty Members API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-AUTH-TOKEN (permanentToken). By default, every request must be authenticated.

  • bearerAuth — JWT obtained from POST /admin/logincheck (admin) or POST /{storeCode}/customer/logincheck (member), sent as Authorization: Bearer .
  • permanentToken — Permanent API token issued to an admin account.

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Members 7

Loyalty members (customers).

POST
/{storeCode}/customer/register
Register a new member
registerCustomer 1 param body → 200
GET
/{storeCode}/customer
List members
listCustomers 3 params → 200
GET
/{storeCode}/customer/check
Check whether a member exists by email or phone
checkCustomer 3 params → 200
GET
/{storeCode}/customer/{customer}
Get a member
getCustomer 2 params → 200
PUT
/{storeCode}/customer/{customer}
Update a member
updateCustomer 2 params body → 200
POST
/{storeCode}/customer/{customer}/level
Assign a member to a level
assignCustomerLevel 2 params body → 200
GET
/{storeCode}/admin/customer/{customer}/history
Get a member's loyalty history
getCustomerHistory 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Customer (8 properties), CustomerRegistration (6 properties). Each schema is shown below with its type and property counts.

Customer
object
8 properties
CustomerRegistration
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-loyalty-members-api-openapi.yml Raw ↑

Other APIs Open Loyalty publishes across the network.

Open Loyalty Authorization API
Open Loyalty Earning Rules API
Open Loyalty Points API
Open Loyalty Rewards API
Open Loyalty Tiers API
Open Loyalty Transactions API
Where this information came from

This is an independent, third-party profile of Open Loyalty Members API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.