Skip to main content

Version 0.3.0

Release Date: February 3, 2026

🔑 API Key Owner Role Authentication

This release introduces Owner role support for API keys, enabling API key authentication as an alternative to JWT tokens for most private endpoints.

What's New

API Key with Owner Role Access

Previously, many endpoints required JWT (Bearer token) authentication only. Now, you can use an API key with Owner role to access the same endpoints. This is useful for:

  • Server-to-server integrations - No need to manage JWT token refresh
  • Automation scripts - Use long-lived API keys instead of short-lived JWTs
  • Third-party integrations - Provide API keys to external services

Supported Endpoints

The following endpoint groups now accept both JWT and API key (Owner role):

Endpoint GroupDescription
/api/v1/quizzesQuiz CRUD operations
/api/v1/questionsQuestion management
/api/v1/question-templatesQuestion template management
/api/v1/participantsParticipant management
/api/v1/info/*Dashboard info and analytics

How to Use

  1. Create an API key with Owner role via the dashboard or API
  2. Include the header x-api-key: your-api-key in your requests
  3. You can use either x-api-key OR Authorization: Bearer <token> - both work
# Using API key
curl -H "x-api-key: your-owner-api-key" \
https://api.example.com/api/v1/quizzes

# Using JWT (still works)
curl -H "Authorization: Bearer your-jwt-token" \
https://api.example.com/api/v1/quizzes

API Key Roles

RoleAccess Level
OwnerFull access to all private endpoints (same as JWT)
UserLimited access for member/client endpoints only

Breaking Changes

None. Existing JWT authentication continues to work unchanged.

Notes

  • API key management endpoints (/api/v1/apikeys) still require JWT authentication only
  • Public endpoints remain accessible without authentication
  • Member endpoints (/api/v1/members/*) continue to use User role API keys