ποΈ 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.