API Reference | Lynes Loyalty API

Lynes Loyalty API Reference

This section provides a central, OpenAPI-style reference for all public Lynes Loyalty and gamification endpoints that are available without tenant-specific routing.

  • Authentication: Most endpoints require a JWT Bearer token. See the JWT Authentication guide.
  • Format: All endpoints use JSON for request and response bodies.
ℹ️

Authentication & Security

Never expose your API secrets or private keys in client-side code or public repositories. Always use backend services or secure vaults to manage secrets.

Domains

The API is grouped into the following domains. Each domain page lists its endpoints with detailed specifications and examples:

Typical Request Structure

curl -X GET "/user/<USER_ID>/points" \
  -H "Authorization: Bearer <JWT_TOKEN>"

Typical JSON Response

{
  "data": {
    "example": true
  }
}

See the individual domain pages for detailed field descriptions, parameter tables, and realistic examples for each endpoint.