Files
TimeTracker/docs/api
Dries Peeters e2d7e21447 feat(api): implement and enhance search API endpoints
- Fix syntax error in existing /api/search endpoint (missing parenthesis in tasks query)
- Enhance /api/search endpoint with types filter, improved error handling, and response metadata
- Add new /api/v1/search endpoint with token-based authentication
  - Requires read:projects scope
  - Respects user permissions (non-admin users see only their own time entries)
  - Supports filtering by entity type (project, task, client, entry)
  - Includes OpenAPI documentation
- Add comprehensive test suite for both endpoints
  - Tests for legacy /api/search (session-based auth)
  - Tests for /api/v1/search (token-based auth)
  - Covers authentication, authorization, filtering, and search functionality
- Update API documentation in docs/api/REST_API.md
  - Add search endpoint documentation with examples
  - Include parameter descriptions and response formats
- Add search endpoint to /api/v1/info endpoint listing

This addresses the HIGH PRIORITY requirement to implement the search API
endpoint that was referenced but may not have been fully functional.

Resolves: Search API endpoint (/api/search) referenced but may not exist
2025-12-29 12:40:38 +01:00
..

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

🔑 Quick Start

  1. Generate an API token in your user settings
  2. Include the token in the Authorization header: Bearer YOUR_TOKEN
  3. Make requests to the API endpoints
  4. 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.