mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-19 04:40:32 -05:00
Dries Peeters
f05d772dbb
- New scopes read:inventory and write:inventory; existing read/write:projects still grant same inventory access for backward compatibility - require_api_token() accepts tuple of scopes (any one required); inventory endpoints accept (read:inventory | read:projects) and (write:inventory | write:projects) - ApiTokenService: add new scopes to allowed list; document in API_TOKEN_SCOPES.md - Add tests for inventory report endpoints with scope checks
API Documentation
Complete API reference for TimeTracker REST API.
📖 Overview
TimeTracker provides a comprehensive REST API for programmatic access to all features. The API supports token-based authentication and follows RESTful principles.
📚 Documentation
- REST API - Complete API reference with all endpoints
- Response Format - Standard error envelope and success/legacy response shapes
- API Token Scopes - Understanding token permissions and scopes
- API Versioning - API versioning strategy and best practices
- API Enhancements - Recent API improvements and additions
🔑 Quick Start
- Create an API token in Admin → Security & Access → Api-tokens (or
/admin/api-tokens) - Include the token in the
Authorizationheader:Bearer YOUR_TOKEN - Make requests to the API endpoints
- Review the API Token Scopes to ensure your token has the required permissions
📋 API Endpoints
See the REST API documentation for a complete list of available endpoints organized by resource type.