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