Skip to main content

​
Welcome to Spruce Rewards API

The Spruce Rewards API is a comprehensive backend platform for managing memberships, rewards, raffles, and customer engagement. Built with GDPR compliance and fraud mitigation in mind, this API provides everything you need to create engaging loyalty and rewards experiences.

​
Key Features

Authentication & Users

Secure user authentication with magic links, password management, and email verification

Rewards & Loyalty

Comprehensive rewards system with referrals, discount codes, and loyalty tracking

Raffles & Contests

Full-featured raffle management with entries, winners, and point-based purchases

Points System

Flexible points system with awards, redemptions, and detailed transaction history

Payments

Integrated payment processing with Revolut and NomuPay support

Analytics & Reports

Comprehensive analytics dashboard with subscription metrics, revenue analysis, and user growth tracking

​
API Specification

This documentation is built from our OpenAPI specification and provides interactive API testing through the playground.

OpenAPI Specification

View the complete OpenAPI specification file

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your authentication token in the Authorization header of each request: 
Authorization: Bearer YOUR_TOKEN_HERE

​
Security Configuration

The API uses the following security scheme defined in the OpenAPI specification: 
"security": [
  {
    "BearerAuth": []
  }
]

​
Getting Started

1

Authenticate

Use the /auth/login or /auth/register endpoints to obtain your authentication token
2

Explore Endpoints

Browse the available endpoint groups in the sidebar to find the functionality you need
3

Test in Playground

Use the interactive API playground to test endpoints with your authentication token
4

Integrate

Implement the API calls in your application using the examples and schemas provided

​
API Organization

The API is organized into the following main groups:
  • Auth - User authentication and registration
  • Users - User profile management and statistics
  • Rewards - Referral codes, loyalty status, and reward tracking
  • Discount Codes - Discount management and wheel spin functionality
  • Raffles - Raffle creation, entries, and winner selection
  • Points - Points awards, redemption, and history
  • Payments - Payment processing and order management
  • Subscriptions - Subscription tiers and credit management
  • Admin - Administrative operations and site configuration
  • Analytics - Business intelligence and reporting
  • Merch - Merchandise product and order management

​
Support

For API support and questions, please refer to the contact information in your OpenAPI specification or reach out to your platform administrator.