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