mirror of https://github.com/DRYTRIX/TimeTracker.git synced 2026-05-19 04:40:32 -05:00

Files

T

Dries Peeters 07dbbd54a3 docs(api): document GET /api/reports/week-comparison

Describe the session JSON endpoint used by the main dashboard week
comparison chart: partial Monday-to-today window, parallel prior week,
dense by_day series, and null change_percent when last week has no hours.

Note the path with other internal dashboard routes in API_VERSIONING.md.

2026-04-27 17:53:54 +02:00

API_CONSISTENCY_AUDIT.md

docs: align versioning and API testing docs with OpenAPI and contracts

2026-04-16 15:09:45 +02:00

API_ENHANCEMENTS.md

…

API_TOKEN_SCOPES.md

docs: API v1 import, bulk, idempotency, rate limits; Linear guide; release tooling

2026-04-05 08:39:22 +02:00

API_VERSIONING.md

docs(api): document GET /api/reports/week-comparison

2026-04-27 17:53:54 +02:00

README.md

docs: update README and guides, add audit and strategy docs

2026-03-15 09:36:37 +01:00

RESPONSE_FORMAT.md

docs: update README and guides, add audit and strategy docs

2026-03-15 09:36:37 +01:00

REST_API.md

docs(api): document GET /api/reports/week-comparison

2026-04-27 17:53:54 +02:00

README.md

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 Authorization header: 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.