Skip to main content

Welcome to Lightyshare API

The Lightyshare API allows users to access and manage their products, bundles, and rentals through third-party integrations. This REST API uses Bearer token authentication to secure all endpoints.

OpenAPI Specification

View the complete OpenAPI specification

Authentication

All API requests require a user authentication token. You can include it in two ways:

Option 2: Query Parameter

Versioning

Lightyshare uses a date-based versioning system to maintain backwards compatibility.

Version Format

API versions use the format YYYY-MM-DD (e.g., 2025-08-16)

How It Works

  1. Token-based versioning: Each API token is automatically tied to the latest version available at creation time
  2. Request-level override: You can specify a different version using the lighty-version header
  3. Stable URLs: API URLs remain stable - versioning is handled via token or header

Examples

The API version used is always returned in the X-API-Version response header.