📄️ API Overview
The Ever Gauzy API is a RESTful HTTP API built with NestJS. It provides comprehensive endpoints for all platform features, with auto-generated OpenAPI (Swagger) documentation.
📄️ REST API
The Ever Gauzy REST API follows standard HTTP conventions with OpenAPI 3.0 (Swagger) documentation auto-generated from NestJS decorators.
📄️ GraphQL API
Ever Gauzy provides a GraphQL API alongside the REST API, offering a flexible, type-safe query language for frontend clients.
📄️ Authentication Endpoints
Complete reference for the authentication API endpoints.
📄️ Employee Endpoints
API endpoints for employee management, profiles, and statistics.
📄️ Organization Endpoints
API endpoints for organization management, departments, teams, and settings.
📄️ Time Tracking Endpoints
API endpoints for time logs, timesheets, activity tracking, and screenshots.
📄️ Task Endpoints
API endpoints for task management, statuses, priorities, and related features.
📄️ Project Endpoints
API endpoints for project management, modules, and sprints.
📄️ Invoice Endpoints
API endpoints for invoice management, estimates, and payments.
📄️ Expense Endpoints
API endpoints for expense tracking, income management, and recurring expenses.
📄️ Candidate Endpoints
API endpoints for Applicant Tracking System (ATS) — candidates, interviews, and pipelines.
📄️ Dashboard Endpoints
API endpoints for dashboard widgets, statistics, and summary data.
📄️ Integration Endpoints
API endpoints for managing third-party integrations.
📄️ Goal Endpoints
API endpoints for Goals, Key Results, and KPIs.
📄️ Pagination & Filtering
All list endpoints in the Ever Gauzy API support pagination, sorting, filtering, and relation loading through query parameters.
📄️ Error Handling
How the Ever Gauzy API handles errors and how to interpret error responses.
📄️ Product Endpoints
API endpoints for Products, Variants, Categories, and Warehouses.
📄️ Equipment Endpoints
API endpoints for Equipment and Equipment Sharing.
📄️ Tags & Skills Endpoints
API endpoints for Tags and Skills management.