📄️ 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.
📄️ Auth & Email Verification Endpoints
Authentication, registration, password management, and email verification endpoints.
📄️ Approval Policy Endpoints
Manage approval policies for time-off requests, expense reports, and equipment sharing.
📄️ Tenant Endpoints
Manage tenants, tenant settings, and tenant API keys. Tenants are the top-level isolation boundary in Ever Gauzy — all data is scoped to a tenant.
📄️ Accounting Template Endpoints
Manage invoice and estimate templates for custom document layouts.
📄️ User Endpoints
Manage user accounts, profiles, preferences, and user-organization associations.
📄️ Candidate Sub-Resource Endpoints
Detailed API reference for candidate feedback, interviews, education, experience, skills, and sources.
📄️ Role & Permission Endpoints
Manage roles, permissions, and role-permission assignments. Roles define what actions users can perform within a tenant.
📄️ Country & Currency Endpoints
Reference data endpoints for countries and currencies.
📄️ Daily Plan Endpoints
Manage daily work plans — assign tasks to specific days, track daily progress, and coordinate team schedules.
📄️ Deal Endpoints
Manage sales deals within pipeline stages.
📄️ Sprint Endpoints
Manage agile sprints — create sprints, assign tasks, track sprint employees, and manage sprint lifecycle.
📄️ Contact Endpoints
Manage organization contacts — customers, vendors, leads, and other business contacts used across the CRM module.
📄️ Employee Sub-Resource Endpoints
API endpoints for employee awards, levels, settings, statistics, and recurring expenses.
📄️ Equipment Sharing Endpoints
Manage equipment sharing requests and policies between employees.
📄️ Pipeline & Deal Endpoints
Manage sales pipelines with multiple stages and deals that progress through the pipeline.
📄️ Income Endpoints
Manage income records for employees and organizations.
📄️ Warehouse Endpoints
Manage warehouses, warehouse products, and product variant inventory.
📄️ Comment & Mention Endpoints
Manage comments, @mentions, and reactions on entities (tasks, projects, etc.).
📄️ Payment Endpoints
Manage payment records linked to invoices and contacts.
📄️ Email Template Endpoints
Manage email templates, custom SMTP configurations, and email sending history.
📄️ Organization Sub-Resource Endpoints
Manage departments, positions, teams, vendors, and organization settings.
📄️ Expense Category Endpoints
Manage expense categories for organizing expense records.
📄️ Image Asset Endpoints
Upload and manage image assets (avatars, logos, screenshots, documents).
📄️ Report Endpoints
Manage reports, report categories, and report configurations for analytics and data visualization.
📄️ Public API Endpoints
Public endpoints that bypass authentication, providing read-only access to shared resources like public invoices, employee profiles, organizations, and teams.
📄️ Favorite Endpoints
Manage user favorites — bookmark entities (tasks, projects, contacts) for quick access.
📄️ Feature Toggle Endpoints
Manage feature flags to enable/disable platform features per tenant or organization.
📄️ Invite Endpoints
Manage user and employee invitations — send, accept, resend, and track invitations.
📄️ Entity Subscription Endpoints
Subscribe to entities (tasks, projects, etc.) to receive notifications when changes occur.
📄️ Screening Task Endpoints
Manage candidate screening tasks — assign evaluation tasks during the hiring process.
📄️ Activity Log Endpoints
Query activity logs and API call logs for auditing and debugging purposes.
📄️ Employee Availability Endpoints
Manage employee schedules, availability slots, appointments, and event types.
📄️ Access Token Endpoints
Manage API access tokens for programmatic access.
📄️ API Call Log Endpoints
Query the API request audit log for monitoring and debugging.
📄️ Email History Endpoints
Query email delivery history and status.
📄️ Event Type Endpoints
Manage event types for employee appointment scheduling.
📄️ Merchant Endpoints
Manage merchants for product and inventory management.
📄️ Product Category Endpoints
Manage product categories for e-commerce features.
📄️ Social Account Endpoints
Manage linked social/OAuth accounts for users.
📄️ Product Variant Endpoints
Manage product variants (sizes, colors, configurations).
📄️ Employee Phone Endpoints
Manage employee phone numbers.
📄️ Language Endpoints
Manage available languages for organizations.
📄️ Employee Notification Endpoints
Manage employee notification preferences and settings.
📄️ Skills Endpoints
Manage organizational and employee skills.
📄️ Proposal Endpoints
Manage sales proposals for clients.
📄️ Recurring Expense Endpoints
Manage recurring expenses for organizations and employees.
📄️ Currency Endpoints
Manage currencies for organizations.
📄️ Estimate Endpoints
Manage quotes and cost estimates for clients.
📄️ Knowledge Base Endpoints
Manage knowledge base articles and categories.
📄️ Country Endpoints
Manage countries for business configuration.
📄️ Tag Endpoints
Manage tags for flexible entity categorization.
📄️ Appointment Endpoints
Manage employee appointments and scheduling.