๐๏ธ 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.