# Workforce Operating System

> WorkforceOS is a unified, web-based platform that enables businesses to efficiently manage employees, schedules, attendance, tasks, and workforce operations with full company-level data isolation. Designed for multi-role access, internal departments, AI-driven insights, and integrated communication via email and in-app notifications.

This documentation is designed to be consumed by both humans and AI agents. It provides comprehensive information about the backend services, APIs, data models, and integration patterns.

## Detailed Documentation Files

For comprehensive documentation, the following detailed files are available:

- **[llms-full.txt](/document/llms-full.txt)**: Complete documentation including all service designs, data models, and API specifications in a single document with nested table of contents.

- **[llms-restapi.txt](/document/llms-restapi.txt)**: REST API focused documentation containing all service REST API guides combined. Ideal for understanding HTTP endpoints, request/response formats, and integration patterns.

- **[llms-prompts.txt](/document/llms-prompts.txt)**: Frontend development prompts for AI-assisted UI building. Contains detailed specifications for implementing frontend features with data models, API endpoints, and UI requirements.

## Documentation Overview

# Workforce Operating System
Version : 1.0.355

WorkforceOS is a unified, web-based platform that enables businesses to efficiently manage employees, schedules, attendance, tasks, and workforce operations with full company-level data isolation. Designed for multi-role access, internal departments, AI-driven insights, and integrated communication via email and in-app notifications.

## How to Use Project Documents

The `Workforceos` project has been designed and generated using **Mindbricks**, a powerful microservice-based backend generation platform. All documentation is automatically produced by the **Mindbricks Genesis Engine**, based on the high-level architectural patterns defined by the user or inferred by AI.

This documentation set is intended for both **AI agents** and **human developers**—including frontend and backend engineers—who need precise and structured information about how to interact with the backend services of this project. Each document reflects the live architecture of the system, providing a reliable reference for API consumption, data models, authentication flows, and business logic.

By following this documentation, developers can seamlessly integrate with the backend, while AI agents can use it to reason about the service structure, make accurate decisions, or even generate compatible client-side code.

## Accessing Project Services

Each service generated by Mindbricks is exposed via a **dedicated REST API** endpoint. Every service documentation set includes the **base URL** of that service along with the **specific API paths** for each available route.

Before consuming any API, developers or agents must understand the service URL structure and environment-specific endpoints.

### Service Endpoint Structure

| Environment | URL Pattern Example |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/auth-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/auth-api` |
| **Production** | `https://workforceos.mindbricks.co/auth-api` |


Replace `auth` with the actual service name as lower case (e.g., `order-api`, `bff-service`, customermanagement-api etc.).

### Environment Usage Notes

* **Preview APIs** become accessible after a project is previewed inside the Mindbricks platform. These are ideal for development and testing.
* **Staging** and **Production** APIs are only accessible after the project is deployed to cloud environments provisioned via Mindbricks.
* In some cases, the project owner may choose to deploy services on their **own infrastructure**. In such scenarios, the service base URLs will be **custom** and should be communicated manually by the project owner to developers or AI agents.

> **Frontend applications** should be designed to **easily switch between environments**, allowing dynamic endpoint targeting for Preview, Staging, and Production.

## Getting Started: Use the Auth Service First

Before interacting with other services in the `Workforceos` project, **AI agents and developers should begin by integrating with the Auth Service**.

Mindbricks automatically generates a dedicated authentication microservice based on the project’s authentication definitions provided by the architect. This service provides the essential user and access management foundation for the project.

Agents should first utilize the Auth Service to:

* Register and authenticate users (login)
* Manage users, roles, and permissions
* Handle user groups (if defined)
* Support multi-tenancy logic (if configured)
* Perform Policy-Based Access Control (PBAC), if activated by the architect

### Auth Service Documentation

Use the following resources to understand and integrate the Auth Service:

* **REST API Guide** – ideal for frontend and direct HTTP usage  
  [Auth REST API Guide](/document/docs/auth-service/rest-api-guide.html)

* **Event Guide** – helpful for event-driven or cross-service integrations  
  [Auth Event Guide](/document/docs/auth-service/event-guide.html)

* **Service Design Document** – overall structure, patterns, and logic  
  [Auth Service Design](/document/docs/auth-service/service-design.html)

> **Note:** For most frontend use cases, the **REST API Guide** will be the primary source. The **Event Guide** and **Service Design** documents are especially useful when integrating with other backend microservices or building systems that interact with the auth service indirectly.

## Using the BFF (Backend-for-Frontend) Service

In Mindbricks, all backend services are designed with an advanced **CQRS (Command Query Responsibility Segregation)** architecture. Within this architecture, **business services** are responsible for managing their respective domains and ensuring the accuracy and freshness of domain data.

The **BFF service** complements these business services by providing a **read-only** aggregation and query layer tailored specifically for frontend and client-side applications.

### Key Principles of the BFF Service

* **Elasticsearch Replicas for Fast Queries:**  
  Each data object managed by a business service is automatically replicated as an **Elasticsearch index**, making it accessible for fast, frontend-oriented queries through the BFF.

* **Cross-Service Data Aggregation:**  
  The BFF offers an **aggregation layer** capable of combining data across multiple services, enabling complex filters, searches, and unified views of related data.

* **Read-Only by Design:**  
  The BFF service is **strictly read-only**. All create, update, or delete operations must be performed through the relevant business services, or via event-driven sagas if designed.

### BFF Service Documentation

* **REST API Guide** – querying aggregated and indexed data  
  [BFF REST API Guide](/document/docs/bff-service/rest-api-guide.html)

* **Event Guide** – syncing strategies across replicas  
  [BFF Event Guide](/document/docs/bff-service/event-guide.html)

* **Service Design** – aggregation patterns and index structures  
  [BFF Service Design](/document/docs/bff-service/service-design.html)

> **Tip:** Use the BFF service as the **main entry point for all frontend data queries**. It simplifies access, reduces round-trips, and ensures that data is shaped appropriately for the UI layer.

## Business Services Overview

The `Workforce Operating System` project consists of multiple **business services**, each responsible for managing a specific domain within the system. These services expose their own REST APIs and documentation sets, and are accessible based on the environment (Preview, Staging, Production).

### Usage Guidance

Business services are primarily designed to:

* Handle the **state and operations of domain data**
* Offer **Create, Update, Delete** operations over owned entities
* Serve **direct data queries** (`get`, `list`) for their own objects when needed

For advanced query needs across multiple services or aggregated views, prefer using the [BFF service](#using-the-bff-backend-for-frontend-service).

### Available Business Services


### employeeProfile Service

**Description:** Manages extended employee profile data, employment/tax details, and employee-related documents/certifications for each company. Extends user identities with HR, department, and compliance info. Allows managers and admins to review employee profiles and documents..

**Documentation:**

* [REST API Guide](/document/docs/employeeProfile-service/rest-api-guide.html)
* [Event Guide](/document/docs/employeeProfile-service/event-guide.html)
* [Service Design](/document/docs/employeeProfile-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/employeeprofile-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/employeeprofile-api` |
| **Production** | `https://workforceos.mindbricks.co/employeeprofile-api` |


### scheduleManagement Service

**Description:** Microservice managing shift scheduling, shift templates, assignment of users/departments to shifts, and schedule conflict detection for WorkforceOS.

**Documentation:**

* [REST API Guide](/document/docs/scheduleManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/scheduleManagement-service/event-guide.html)
* [Service Design](/document/docs/scheduleManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/schedulemanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/schedulemanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/schedulemanagement-api` |


### attendanceManagement Service

**Description:** Handles employee attendance logging (check-in/out), attendance rules (lateness/absence/early-leave), real-time & historical logs, and publishes notification events. Enforces company data isolation, strict record uniqueness, and one-per-shift attendance rule.

**Documentation:**

* [REST API Guide](/document/docs/attendanceManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/attendanceManagement-service/event-guide.html)
* [Service Design](/document/docs/attendanceManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/attendancemanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/attendancemanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/attendancemanagement-api` |


### taskManagement Service

**Description:** Handles creation, assignment, update, and tracking of tasks tied to employees, shifts, or departments. Supports admins/managers assigning tasks; employees viewing and completing tasks; accountability tracking. Exposes APIs for creating, updating, deleting, and listing tasks with data enrichment. Data is .company-tenant-scoped..

**Documentation:**

* [REST API Guide](/document/docs/taskManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/taskManagement-service/event-guide.html)
* [Service Design](/document/docs/taskManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/taskmanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/taskmanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/taskmanagement-api` |


### leaveManagement Service

**Description:** Handles employee leave/absence requests, review/approval workflows, and automatic integration with shift assignments, ensuring company data isolation and leave history access for employees and managers/admins.

**Documentation:**

* [REST API Guide](/document/docs/leaveManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/leaveManagement-service/event-guide.html)
* [Service Design](/document/docs/leaveManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/leavemanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/leavemanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/leavemanagement-api` |


### payrollReporting Service

**Description:** Handles payroll report records for employees based on calculated hours, overtime, absences from attendance/leave. Provides summary views by user/period/department, allows payment status entry (not processing). Employees can view their own reports. Company tenant scoped and RBAC-enforced.

**Documentation:**

* [REST API Guide](/document/docs/payrollReporting-service/rest-api-guide.html)
* [Event Guide](/document/docs/payrollReporting-service/event-guide.html)
* [Service Design](/document/docs/payrollReporting-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/payrollreporting-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/payrollreporting-api` |
| **Production** | `https://workforceos.mindbricks.co/payrollreporting-api` |


### announcementManagement Service

**Description:** Handles company-wide and department-specific announcements, supporting scheduled or immediate delivery. Enables admins/managers to create, edit, and manage rich-text announcements, assign audience (all/company/department/users), and triggers events for notification delivery. Employees see relevant announcements in history/detail. Fully tenant-scoped.

**Documentation:**

* [REST API Guide](/document/docs/announcementManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/announcementManagement-service/event-guide.html)
* [Service Design](/document/docs/announcementManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/announcementmanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/announcementmanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/announcementmanagement-api` |


### aiWorkforceAnalytics Service

**Description:** Microservice for computing and delivering AI-powered workforce analytics (e.g., shift optimization, absenteeism insights, staffing trends) for eligible (subscribed) companies. Handles insight calculation, storage, and secure distribution to authorized users. Publishes insight alerts/events for notifications. Strictly enforces company data isolation and subscription gating on all features.

**Documentation:**

* [REST API Guide](/document/docs/aiWorkforceAnalytics-service/rest-api-guide.html)
* [Event Guide](/document/docs/aiWorkforceAnalytics-service/event-guide.html)
* [Service Design](/document/docs/aiWorkforceAnalytics-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/aiworkforceanalytics-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/aiworkforceanalytics-api` |
| **Production** | `https://workforceos.mindbricks.co/aiworkforceanalytics-api` |


### subscriptionManagement Service

**Description:** Manages company AI subscriptions through Stripe payments. Companies must pay via Stripe to activate AI features—no manual subscription creation allowed. Handles the full Stripe payment lifecycle: checkout, payment confirmation, activation, and cancellation. The subscription status is entirely driven by Stripe webhook events. SuperAdmin/saasAdmin bypass payment for platform management.

**Documentation:**

* [REST API Guide](/document/docs/subscriptionManagement-service/rest-api-guide.html)
* [Event Guide](/document/docs/subscriptionManagement-service/event-guide.html)
* [Service Design](/document/docs/subscriptionManagement-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/subscriptionmanagement-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/subscriptionmanagement-api` |
| **Production** | `https://workforceos.mindbricks.co/subscriptionmanagement-api` |


### agentHub Service

**Description:** AI Agent Hub

**Documentation:**

* [REST API Guide](/document/docs/agentHub-service/rest-api-guide.html)
* [Event Guide](/document/docs/agentHub-service/event-guide.html)
* [Service Design](/document/docs/agentHub-service/service-design.html)

**Base URL Examples:**

| Environment | URL |
|-------------|---------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/agenthub-api` |
| **Staging** | `https://workforceos-stage.mindbricks.co/agenthub-api` |
| **Production** | `https://workforceos.mindbricks.co/agenthub-api` |


## Connect via MCP (Model Context Protocol)

All backend services in the `Workforceos` project expose their Business APIs as **MCP tools**. These tools are aggregated by the **MCP-BFF** service into a single unified endpoint that external AI tools can connect to.

### Unified MCP Endpoint

| Environment | StreamableHTTP (recommended) | SSE (legacy fallback) |
|-------------|------------------------------|------------------------|
| **Preview** | `https://workforceos.prw.mindbricks.com/mcpbff-api/mcp` | `https://workforceos.prw.mindbricks.com/mcpbff-api/mcp/sse` |
| **Staging** | `https://workforceos-stage.mindbricks.co/mcpbff-api/mcp` | `https://workforceos-stage.mindbricks.co/mcpbff-api/mcp/sse` |
| **Production** | `https://workforceos.mindbricks.co/mcpbff-api/mcp` | `https://workforceos.mindbricks.co/mcpbff-api/mcp/sse` |

### Authentication

MCP connections require authentication via the `Authorization` header:

- **API Key (recommended for AI agents):** `Authorization: Bearer sk_mbx_your_api_key_here`
  API keys are long-lived and don't expire like JWT tokens. Create one from the profile page.
- **JWT Token:** `Authorization: Bearer {accessToken}`
  Use a valid access token obtained from the login API.

> **OAuth is not supported** for MCP connections at this time.

### Connecting from Cursor

Add the following to your project's `.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "workforceos": {
      "url": "https://workforceos.prw.mindbricks.com/mcpbff-api/mcp",
      "headers": {
        "Authorization": "Bearer sk_mbx_your_api_key_here"
      }
    }
  }
}
```

### Connecting from Claude Desktop

Add to your Claude Desktop configuration (`claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "workforceos": {
      "url": "https://workforceos.prw.mindbricks.com/mcpbff-api/mcp",
      "headers": {
        "Authorization": "Bearer sk_mbx_your_api_key_here"
      }
    }
  }
}
```

### What's Available

Once connected, the AI tool can discover and call all Business API tools from all services — CRUD operations, custom queries, file operations, and more. The MCP-BFF handles routing each tool call to the correct backend service and propagates your authentication context.

---

## Conclusion

This documentation set provides a comprehensive guide for understanding and consuming the `Workforce Operating System` backend, generated by the Mindbricks platform. It is structured to support both AI agents and human developers in navigating authentication, data access, service responsibilities, and system architecture.

To summarize:

* Start with the **Auth Service** to manage users, roles, sessions, and permissions.
* Use the **BFF Service** for optimized, read-only data queries and cross-service aggregation.
* Refer to the **Business Services** when you need to manage domain-specific data or perform direct CRUD operations.

Each service offers a complete set of documentation—REST API guides, event interface definitions, and design insights—to help you integrate efficiently and confidently.

Whether you are building a frontend application, configuring an automation agent, or simply exploring the architecture, this documentation is your primary reference for working with the backend of this project.

> For environment-specific access, ensure you're using the correct base URLs (Preview, Staging, Production), and coordinate with the project owner for any custom deployments.

## Table of Contents

### Getting Started

- [Introduction](/document/docs/intro.html): Workforce Operating System

### Frontend Prompts

- [Project Introduction & Setup](/document/docs/frontend-prompts/frontend-prompt-1-projectIntroduction.html): Project Introduction & Setup
- [Authentication Management](/document/docs/frontend-prompts/frontend-prompt-2-authManagement.html): Authentication Management
- [Verification Management](/document/docs/frontend-prompts/frontend-prompt-3-verification.html): Verification Management
- [Profile Management](/document/docs/frontend-prompts/frontend-prompt-4-profile.html): Profile Management
- [User Management](/document/docs/frontend-prompts/frontend-prompt-5-userManagement.html): User Management
- [MCP BFF Integration](/document/docs/frontend-prompts/frontend-prompt-6-mcpbffIntegration.html): MCP BFF Integration
- [EmployeeProfile Service](/document/docs/frontend-prompts/frontend-prompt-7-employeeProfileService.html): EmployeeProfile Service
- [ScheduleManagement Service](/document/docs/frontend-prompts/frontend-prompt-8-scheduleManagementService.html): ScheduleManagement Service
- [AttendanceManagement Service](/document/docs/frontend-prompts/frontend-prompt-9-attendanceManagementService.html): AttendanceManagement Service
- [TaskManagement Service](/document/docs/frontend-prompts/frontend-prompt-10-taskManagementService.html): TaskManagement Service
- [LeaveManagement Service](/document/docs/frontend-prompts/frontend-prompt-11-leaveManagementService.html): LeaveManagement Service
- [PayrollReporting Service](/document/docs/frontend-prompts/frontend-prompt-12-payrollReportingService.html): PayrollReporting Service
- [AnnouncementManagement Service](/document/docs/frontend-prompts/frontend-prompt-13-announcementManagementService.html): AnnouncementManagement Service
- [AiWorkforceAnalytics Service](/document/docs/frontend-prompts/frontend-prompt-14-aiWorkforceAnalyticsService.html): AiWorkforceAnalytics Service
- [SubscriptionManagement Service](/document/docs/frontend-prompts/frontend-prompt-15-subscriptionManagementService.html): SubscriptionManagement Service
- [SubscriptionManagement Service CompanySubscription Payment Flow](/document/docs/frontend-prompts/frontend-prompt-16-companySubscription-payment-flow.html): SubscriptionManagement Service CompanySubscription Payment Flow
- [AgentHub Service](/document/docs/frontend-prompts/frontend-prompt-17-agentHubService.html): AgentHub Service

### Auth Service

- [Service Design](/document/docs/auth-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/auth-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/auth-service/event-guide.html): .
#### Data Objects
- [user Design](/document/docs/auth-service/user-design.html): Documentation
- [userGroup Design](/document/docs/auth-service/userGroup-design.html): Documentation
- [userGroupMember Design](/document/docs/auth-service/userGroupMember-design.html): Documentation
- [company Design](/document/docs/auth-service/company-design.html): Documentation
- [userAvatarsFile Design](/document/docs/auth-service/userAvatarsFile-design.html): Documentation
- [companyAvatarsFile Design](/document/docs/auth-service/companyAvatarsFile-design.html): Documentation
#### Business APIs
- [getUser API](/document/docs/auth-service/business-api/getUser-api-design.html): Business API Design Specification - `Get User`
- [updateUser API](/document/docs/auth-service/business-api/updateUser-api-design.html): Business API Design Specification - `Update User`
- [updateProfile API](/document/docs/auth-service/business-api/updateProfile-api-design.html): Business API Design Specification - `Update Profile`
- [createUser API](/document/docs/auth-service/business-api/createUser-api-design.html): Business API Design Specification - `Create User`
- [deleteUser API](/document/docs/auth-service/business-api/deleteUser-api-design.html): Business API Design Specification - `Delete User`
- [archiveProfile API](/document/docs/auth-service/business-api/archiveProfile-api-design.html): Business API Design Specification - `Archive Profile`
- [listUsers API](/document/docs/auth-service/business-api/listUsers-api-design.html): Business API Design Specification - `List Users`
- [searchUsers API](/document/docs/auth-service/business-api/searchUsers-api-design.html): Business API Design Specification - `Search Users`
- [updateUserRole API](/document/docs/auth-service/business-api/updateUserRole-api-design.html): Business API Design Specification - `Update Userrole`
- [updateUserPassword API](/document/docs/auth-service/business-api/updateUserPassword-api-design.html): Business API Design Specification - `Update Userpassword`
- [updateUserPasswordByAdmin API](/document/docs/auth-service/business-api/updateUserPasswordByAdmin-api-design.html): Business API Design Specification - `Update Userpasswordbyadmin`
- [getBriefUser API](/document/docs/auth-service/business-api/getBriefUser-api-design.html): Business API Design Specification - `Get Briefuser`
- [streamTest API](/document/docs/auth-service/business-api/streamTest-api-design.html): Business API Design Specification - `Stream Test`
- [registerCompanyOwner API](/document/docs/auth-service/business-api/registerCompanyOwner-api-design.html): Business API Design Specification - `Register Companyowner`
- [registerCompanyUser API](/document/docs/auth-service/business-api/registerCompanyUser-api-design.html): Business API Design Specification - `Register Companyuser`
- [createCompany API](/document/docs/auth-service/business-api/createCompany-api-design.html): Business API Design Specification - `Create Company`
- [getCompany API](/document/docs/auth-service/business-api/getCompany-api-design.html): Business API Design Specification - `Get Company`
- [getCompanyHome API](/document/docs/auth-service/business-api/getCompanyHome-api-design.html): Business API Design Specification - `Get Companyhome`
- [getCompanyProfile API](/document/docs/auth-service/business-api/getCompanyProfile-api-design.html): Business API Design Specification - `Get Companyprofile`
- [getCompanyAccount API](/document/docs/auth-service/business-api/getCompanyAccount-api-design.html): Business API Design Specification - `Get Companyaccount`
- [listCompaniesAccounts API](/document/docs/auth-service/business-api/listCompaniesAccounts-api-design.html): Business API Design Specification - `List Companiesaccounts`
- [listBriefCompanies API](/document/docs/auth-service/business-api/listBriefCompanies-api-design.html): Business API Design Specification - `List Briefcompanies`
- [getBriefCompany API](/document/docs/auth-service/business-api/getBriefCompany-api-design.html): Business API Design Specification - `Get Briefcompany`
- [updateCompany API](/document/docs/auth-service/business-api/updateCompany-api-design.html): Business API Design Specification - `Update Company`
- [deleteCompany API](/document/docs/auth-service/business-api/deleteCompany-api-design.html): Business API Design Specification - `Delete Company`
- [createUserGroup API](/document/docs/auth-service/business-api/createUserGroup-api-design.html): Business API Design Specification - `Create Usergroup`
- [updateUserGroup API](/document/docs/auth-service/business-api/updateUserGroup-api-design.html): Business API Design Specification - `Update Usergroup`
- [deleteUserGroup API](/document/docs/auth-service/business-api/deleteUserGroup-api-design.html): Business API Design Specification - `Delete Usergroup`
- [getUserGroup API](/document/docs/auth-service/business-api/getUserGroup-api-design.html): Business API Design Specification - `Get Usergroup`
- [listUserGroups API](/document/docs/auth-service/business-api/listUserGroups-api-design.html): Business API Design Specification - `List Usergroups`
- [getUserGroupMember API](/document/docs/auth-service/business-api/getUserGroupMember-api-design.html): Business API Design Specification - `Get Usergroupmember`
- [createUserGroupMember API](/document/docs/auth-service/business-api/createUserGroupMember-api-design.html): Business API Design Specification - `Create Usergroupmember`
- [deleteUserGroupMember API](/document/docs/auth-service/business-api/deleteUserGroupMember-api-design.html): Business API Design Specification - `Delete Usergroupmember`
- [listUserGroupMembers API](/document/docs/auth-service/business-api/listUserGroupMembers-api-design.html): Business API Design Specification - `List Usergroupmembers`
- [getUserAvatarsFile API](/document/docs/auth-service/business-api/getUserAvatarsFile-api-design.html): Business API Design Specification - `Get Useravatarsfile`
- [listUserAvatarsFiles API](/document/docs/auth-service/business-api/listUserAvatarsFiles-api-design.html): Business API Design Specification - `List Useravatarsfiles`
- [deleteUserAvatarsFile API](/document/docs/auth-service/business-api/deleteUserAvatarsFile-api-design.html): Business API Design Specification - `Delete Useravatarsfile`
- [getCompanyAvatarsFile API](/document/docs/auth-service/business-api/getCompanyAvatarsFile-api-design.html): Business API Design Specification - `Get Companyavatarsfile`
- [listCompanyAvatarsFiles API](/document/docs/auth-service/business-api/listCompanyAvatarsFiles-api-design.html): Business API Design Specification - `List Companyavatarsfiles`
- [deleteCompanyAvatarsFile API](/document/docs/auth-service/business-api/deleteCompanyAvatarsFile-api-design.html): Business API Design Specification - `Delete Companyavatarsfile`
#### Database Buckets
- [userAvatars Bucket](/document/docs/auth-service/db-buckets/userAvatars-bucket-design.html): Database Bucket Design Specification - `userAvatars`
- [companyAvatars Bucket](/document/docs/auth-service/db-buckets/companyAvatars-bucket-design.html): Database Bucket Design Specification - `companyAvatars`
- [Service Library](/document/docs/auth-service/service-library.html): Service Library - `auth`

### EmployeeProfile Service

- [Service Design](/document/docs/employeeProfile-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/employeeProfile-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/employeeProfile-service/event-guide.html): .
#### Data Objects
- [employeeProfile Design](/document/docs/employeeProfile-service/employeeProfile-design.html): Documentation
- [employeeDocument Design](/document/docs/employeeProfile-service/employeeDocument-design.html): Documentation
#### Business APIs
- [createEmployeeProfile API](/document/docs/employeeProfile-service/business-api/createEmployeeProfile-api-design.html): Business API Design Specification - `Create Employeeprofile`
- [updateEmployeeProfile API](/document/docs/employeeProfile-service/business-api/updateEmployeeProfile-api-design.html): Business API Design Specification - `Update Employeeprofile`
- [getEmployeeProfile API](/document/docs/employeeProfile-service/business-api/getEmployeeProfile-api-design.html): Business API Design Specification - `Get Employeeprofile`
- [listEmployeeProfiles API](/document/docs/employeeProfile-service/business-api/listEmployeeProfiles-api-design.html): Business API Design Specification - `List Employeeprofiles`
- [createEmployeeDocument API](/document/docs/employeeProfile-service/business-api/createEmployeeDocument-api-design.html): Business API Design Specification - `Create Employeedocument`
- [updateEmployeeDocument API](/document/docs/employeeProfile-service/business-api/updateEmployeeDocument-api-design.html): Business API Design Specification - `Update Employeedocument`
- [getEmployeeDocument API](/document/docs/employeeProfile-service/business-api/getEmployeeDocument-api-design.html): Business API Design Specification - `Get Employeedocument`
- [listEmployeeDocuments API](/document/docs/employeeProfile-service/business-api/listEmployeeDocuments-api-design.html): Business API Design Specification - `List Employeedocuments`
- [deleteEmployeeProfile API](/document/docs/employeeProfile-service/business-api/deleteEmployeeProfile-api-design.html): Business API Design Specification - `Delete Employeeprofile`
- [deleteEmployeeDocument API](/document/docs/employeeProfile-service/business-api/deleteEmployeeDocument-api-design.html): Business API Design Specification - `Delete Employeedocument`
- [Service Library](/document/docs/employeeProfile-service/service-library.html): Service Library - `employeeProfile`

### ScheduleManagement Service

- [Service Design](/document/docs/scheduleManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/scheduleManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/scheduleManagement-service/event-guide.html): .
#### Data Objects
- [shiftTemplate Design](/document/docs/scheduleManagement-service/shiftTemplate-design.html): Documentation
- [shift Design](/document/docs/scheduleManagement-service/shift-design.html): Documentation
#### Business APIs
- [createShiftTemplate API](/document/docs/scheduleManagement-service/business-api/createShiftTemplate-api-design.html): Business API Design Specification - `Create Shifttemplate`
- [updateShiftTemplate API](/document/docs/scheduleManagement-service/business-api/updateShiftTemplate-api-design.html): Business API Design Specification - `Update Shifttemplate`
- [deleteShiftTemplate API](/document/docs/scheduleManagement-service/business-api/deleteShiftTemplate-api-design.html): Business API Design Specification - `Delete Shifttemplate`
- [getShiftTemplate API](/document/docs/scheduleManagement-service/business-api/getShiftTemplate-api-design.html): Business API Design Specification - `Get Shifttemplate`
- [listShiftTemplates API](/document/docs/scheduleManagement-service/business-api/listShiftTemplates-api-design.html): Business API Design Specification - `List Shifttemplates`
- [createShift API](/document/docs/scheduleManagement-service/business-api/createShift-api-design.html): Business API Design Specification - `Create Shift`
- [updateShift API](/document/docs/scheduleManagement-service/business-api/updateShift-api-design.html): Business API Design Specification - `Update Shift`
- [deleteShift API](/document/docs/scheduleManagement-service/business-api/deleteShift-api-design.html): Business API Design Specification - `Delete Shift`
- [getShift API](/document/docs/scheduleManagement-service/business-api/getShift-api-design.html): Business API Design Specification - `Get Shift`
- [listShifts API](/document/docs/scheduleManagement-service/business-api/listShifts-api-design.html): Business API Design Specification - `List Shifts`
- [Service Library](/document/docs/scheduleManagement-service/service-library.html): Service Library - `scheduleManagement`

### AttendanceManagement Service

- [Service Design](/document/docs/attendanceManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/attendanceManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/attendanceManagement-service/event-guide.html): .
#### Data Objects
- [attendanceRecord Design](/document/docs/attendanceManagement-service/attendanceRecord-design.html): Documentation
#### Business APIs
- [checkInAttendance API](/document/docs/attendanceManagement-service/business-api/checkInAttendance-api-design.html): Business API Design Specification - `Check Inattendance`
- [checkOutAttendance API](/document/docs/attendanceManagement-service/business-api/checkOutAttendance-api-design.html): Business API Design Specification - `Check Outattendance`
- [markAttendanceAbsent API](/document/docs/attendanceManagement-service/business-api/markAttendanceAbsent-api-design.html): Business API Design Specification - `Mark Attendanceabsent`
- [getAttendanceRecord API](/document/docs/attendanceManagement-service/business-api/getAttendanceRecord-api-design.html): Business API Design Specification - `Get Attendancerecord`
- [listAttendanceRecords API](/document/docs/attendanceManagement-service/business-api/listAttendanceRecords-api-design.html): Business API Design Specification - `List Attendancerecords`
- [Service Library](/document/docs/attendanceManagement-service/service-library.html): Service Library - `attendanceManagement`

### TaskManagement Service

- [Service Design](/document/docs/taskManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/taskManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/taskManagement-service/event-guide.html): .
#### Data Objects
- [taskAssignment Design](/document/docs/taskManagement-service/taskAssignment-design.html): Documentation
- [individualTask Design](/document/docs/taskManagement-service/individualTask-design.html): Documentation
#### Business APIs
- [createTaskAssignment API](/document/docs/taskManagement-service/business-api/createTaskAssignment-api-design.html): Business API Design Specification - `Create Taskassignment`
- [listMyIndividualTasks API](/document/docs/taskManagement-service/business-api/listMyIndividualTasks-api-design.html): Business API Design Specification - `List Myindividualtasks`
- [getTaskAssignmentWithProgress API](/document/docs/taskManagement-service/business-api/getTaskAssignmentWithProgress-api-design.html): Business API Design Specification - `Get Taskassignmentwithprogress`
- [getMyIndividualTask API](/document/docs/taskManagement-service/business-api/getMyIndividualTask-api-design.html): Business API Design Specification - `Get Myindividualtask`
- [listTaskAssignments API](/document/docs/taskManagement-service/business-api/listTaskAssignments-api-design.html): Business API Design Specification - `List Taskassignments`
- [deleteTaskAssignment API](/document/docs/taskManagement-service/business-api/deleteTaskAssignment-api-design.html): Business API Design Specification - `Delete Taskassignment`
- [updateIndividualTask API](/document/docs/taskManagement-service/business-api/updateIndividualTask-api-design.html): Business API Design Specification - `Update Individualtask`
- [updateTaskAssignment API](/document/docs/taskManagement-service/business-api/updateTaskAssignment-api-design.html): Business API Design Specification - `Update Taskassignment`
- [createIndividualTask API](/document/docs/taskManagement-service/business-api/createIndividualTask-api-design.html): Business API Design Specification - `Create Individualtask`
- [deleteIndividualTask API](/document/docs/taskManagement-service/business-api/deleteIndividualTask-api-design.html): Business API Design Specification - `Delete Individualtask`
- [Service Library](/document/docs/taskManagement-service/service-library.html): Service Library - `taskManagement`

### LeaveManagement Service

- [Service Design](/document/docs/leaveManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/leaveManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/leaveManagement-service/event-guide.html): .
#### Data Objects
- [leaveRequest Design](/document/docs/leaveManagement-service/leaveRequest-design.html): Documentation
#### Business APIs
- [createLeaveRequest API](/document/docs/leaveManagement-service/business-api/createLeaveRequest-api-design.html): Business API Design Specification - `Create Leaverequest`
- [updateLeaveRequest API](/document/docs/leaveManagement-service/business-api/updateLeaveRequest-api-design.html): Business API Design Specification - `Update Leaverequest`
- [deleteLeaveRequest API](/document/docs/leaveManagement-service/business-api/deleteLeaveRequest-api-design.html): Business API Design Specification - `Delete Leaverequest`
- [getLeaveRequest API](/document/docs/leaveManagement-service/business-api/getLeaveRequest-api-design.html): Business API Design Specification - `Get Leaverequest`
- [listLeaveRequests API](/document/docs/leaveManagement-service/business-api/listLeaveRequests-api-design.html): Business API Design Specification - `List Leaverequests`
- [listMyLeaveRequests API](/document/docs/leaveManagement-service/business-api/listMyLeaveRequests-api-design.html): Business API Design Specification - `List Myleaverequests`
- [getMyLeaveRequest API](/document/docs/leaveManagement-service/business-api/getMyLeaveRequest-api-design.html): Business API Design Specification - `Get Myleaverequest`
- [Service Library](/document/docs/leaveManagement-service/service-library.html): Service Library - `leaveManagement`

### PayrollReporting Service

- [Service Design](/document/docs/payrollReporting-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/payrollReporting-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/payrollReporting-service/event-guide.html): .
#### Data Objects
- [payrollReport Design](/document/docs/payrollReporting-service/payrollReport-design.html): Documentation
#### Business APIs
- [createPayrollReport API](/document/docs/payrollReporting-service/business-api/createPayrollReport-api-design.html): Business API Design Specification - `Create Payrollreport`
- [updatePayrollReport API](/document/docs/payrollReporting-service/business-api/updatePayrollReport-api-design.html): Business API Design Specification - `Update Payrollreport`
- [getPayrollReport API](/document/docs/payrollReporting-service/business-api/getPayrollReport-api-design.html): Business API Design Specification - `Get Payrollreport`
- [listPayrollReports API](/document/docs/payrollReporting-service/business-api/listPayrollReports-api-design.html): Business API Design Specification - `List Payrollreports`
- [Service Library](/document/docs/payrollReporting-service/service-library.html): Service Library - `payrollReporting`

### AnnouncementManagement Service

- [Service Design](/document/docs/announcementManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/announcementManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/announcementManagement-service/event-guide.html): .
#### Data Objects
- [announcement Design](/document/docs/announcementManagement-service/announcement-design.html): Documentation
#### Business APIs
- [createAnnouncement API](/document/docs/announcementManagement-service/business-api/createAnnouncement-api-design.html): Business API Design Specification - `Create Announcement`
- [updateAnnouncement API](/document/docs/announcementManagement-service/business-api/updateAnnouncement-api-design.html): Business API Design Specification - `Update Announcement`
- [deleteAnnouncement API](/document/docs/announcementManagement-service/business-api/deleteAnnouncement-api-design.html): Business API Design Specification - `Delete Announcement`
- [getAnnouncement API](/document/docs/announcementManagement-service/business-api/getAnnouncement-api-design.html): Business API Design Specification - `Get Announcement`
- [listAnnouncements API](/document/docs/announcementManagement-service/business-api/listAnnouncements-api-design.html): Business API Design Specification - `List Announcements`
- [processScheduledAnnouncements API](/document/docs/announcementManagement-service/business-api/processScheduledAnnouncements-api-design.html): Business API Design Specification - `Process Scheduledannouncements`
- [Service Library](/document/docs/announcementManagement-service/service-library.html): Service Library - `announcementManagement`

### AiWorkforceAnalytics Service

- [Service Design](/document/docs/aiWorkforceAnalytics-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/aiWorkforceAnalytics-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/aiWorkforceAnalytics-service/event-guide.html): .
#### Data Objects
- [aiInsight Design](/document/docs/aiWorkforceAnalytics-service/aiInsight-design.html): Documentation
#### Business APIs
- [createAiInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/createAiInsight-api-design.html): Business API Design Specification - `Create Aiinsight`
- [updateAiInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/updateAiInsight-api-design.html): Business API Design Specification - `Update Aiinsight`
- [getAiInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/getAiInsight-api-design.html): Business API Design Specification - `Get Aiinsight`
- [listAiInsights API](/document/docs/aiWorkforceAnalytics-service/business-api/listAiInsights-api-design.html): Business API Design Specification - `List Aiinsights`
- [deleteAiInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/deleteAiInsight-api-design.html): Business API Design Specification - `Delete Aiinsight`
- [saveInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/saveInsight-api-design.html): Business API Design Specification - `Save Insight`
- [saveAiInsight API](/document/docs/aiWorkforceAnalytics-service/business-api/saveAiInsight-api-design.html): Business API Design Specification - `Save Aiinsight`
#### AI Agents
- [insightGenerator Agent](/document/docs/aiWorkforceAnalytics-service/ai-agents/insightGenerator-agent-design.html): AI Agent Design Specification - `insightGenerator`
- [Service Library](/document/docs/aiWorkforceAnalytics-service/service-library.html): Service Library - `aiWorkforceAnalytics`

### SubscriptionManagement Service

- [Service Design](/document/docs/subscriptionManagement-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/subscriptionManagement-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/subscriptionManagement-service/event-guide.html): .
#### Data Objects
- [companySubscription Design](/document/docs/subscriptionManagement-service/companySubscription-design.html): Documentation
- [sys_companySubscriptionPayment Design](/document/docs/subscriptionManagement-service/sys_companySubscriptionPayment-design.html): Documentation
- [sys_paymentCustomer Design](/document/docs/subscriptionManagement-service/sys_paymentCustomer-design.html): Documentation
- [sys_paymentMethod Design](/document/docs/subscriptionManagement-service/sys_paymentMethod-design.html): Documentation
#### Business APIs
- [createCompanySubscription API](/document/docs/subscriptionManagement-service/business-api/createCompanySubscription-api-design.html): Business API Design Specification - `Create Companysubscription`
- [updateCompanySubscription API](/document/docs/subscriptionManagement-service/business-api/updateCompanySubscription-api-design.html): Business API Design Specification - `Update Companysubscription`
- [getCompanySubscription API](/document/docs/subscriptionManagement-service/business-api/getCompanySubscription-api-design.html): Business API Design Specification - `Get Companysubscription`
- [listCompanySubscriptions API](/document/docs/subscriptionManagement-service/business-api/listCompanySubscriptions-api-design.html): Business API Design Specification - `List Companysubscriptions`
- [deleteCompanySubscription API](/document/docs/subscriptionManagement-service/business-api/deleteCompanySubscription-api-design.html): Business API Design Specification - `Delete Companysubscription`
- [cancelCompanySubscription API](/document/docs/subscriptionManagement-service/business-api/cancelCompanySubscription-api-design.html): Business API Design Specification - `Cancel Companysubscription`
- [getCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/getCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Get Companysubscriptionpayment`
- [listCompanySubscriptionPayments API](/document/docs/subscriptionManagement-service/business-api/listCompanySubscriptionPayments-api-design.html): Business API Design Specification - `List Companysubscriptionpayments`
- [createCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/createCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Create Companysubscriptionpayment`
- [updateCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/updateCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Update Companysubscriptionpayment`
- [deleteCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/deleteCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Delete Companysubscriptionpayment`
- [getCompanySubscriptionPaymentByOrderId API](/document/docs/subscriptionManagement-service/business-api/getCompanySubscriptionPaymentByOrderId-api-design.html): Business API Design Specification - `Get Companysubscriptionpaymentbyorderid`
- [getCompanySubscriptionPaymentByPaymentId API](/document/docs/subscriptionManagement-service/business-api/getCompanySubscriptionPaymentByPaymentId-api-design.html): Business API Design Specification - `Get Companysubscriptionpaymentbypaymentid`
- [startCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/startCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Start Companysubscriptionpayment`
- [refreshCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/refreshCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Refresh Companysubscriptionpayment`
- [callbackCompanySubscriptionPayment API](/document/docs/subscriptionManagement-service/business-api/callbackCompanySubscriptionPayment-api-design.html): Business API Design Specification - `Callback Companysubscriptionpayment`
- [getPaymentCustomerByUserId API](/document/docs/subscriptionManagement-service/business-api/getPaymentCustomerByUserId-api-design.html): Business API Design Specification - `Get Paymentcustomerbyuserid`
- [listPaymentCustomers API](/document/docs/subscriptionManagement-service/business-api/listPaymentCustomers-api-design.html): Business API Design Specification - `List Paymentcustomers`
- [listPaymentCustomerMethods API](/document/docs/subscriptionManagement-service/business-api/listPaymentCustomerMethods-api-design.html): Business API Design Specification - `List Paymentcustomermethods`
- [Service Library](/document/docs/subscriptionManagement-service/service-library.html): Service Library - `subscriptionManagement`

### AgentHub Service

- [Service Design](/document/docs/agentHub-service/service-design.html): Service Design Specification
- [REST API Guide](/document/docs/agentHub-service/rest-api-guide.html): REST API GUIDE 
- [Event Guide](/document/docs/agentHub-service/event-guide.html): .
#### Data Objects
- [sys_agentOverride Design](/document/docs/agentHub-service/sys_agentOverride-design.html): Documentation
- [sys_agentExecution Design](/document/docs/agentHub-service/sys_agentExecution-design.html): Documentation
- [sys_toolCatalog Design](/document/docs/agentHub-service/sys_toolCatalog-design.html): Documentation
#### Business APIs
- [getAgentOverride API](/document/docs/agentHub-service/business-api/getAgentOverride-api-design.html): Business API Design Specification - `Get Agentoverride`
- [listAgentOverrides API](/document/docs/agentHub-service/business-api/listAgentOverrides-api-design.html): Business API Design Specification - `List Agentoverrides`
- [updateAgentOverride API](/document/docs/agentHub-service/business-api/updateAgentOverride-api-design.html): Business API Design Specification - `Update Agentoverride`
- [createAgentOverride API](/document/docs/agentHub-service/business-api/createAgentOverride-api-design.html): Business API Design Specification - `Create Agentoverride`
- [deleteAgentOverride API](/document/docs/agentHub-service/business-api/deleteAgentOverride-api-design.html): Business API Design Specification - `Delete Agentoverride`
- [listToolCatalog API](/document/docs/agentHub-service/business-api/listToolCatalog-api-design.html): Business API Design Specification - `List Toolcatalog`
- [getToolCatalogEntry API](/document/docs/agentHub-service/business-api/getToolCatalogEntry-api-design.html): Business API Design Specification - `Get Toolcatalogentry`
- [listAgentExecutions API](/document/docs/agentHub-service/business-api/listAgentExecutions-api-design.html): Business API Design Specification - `List Agentexecutions`
- [getAgentExecution API](/document/docs/agentHub-service/business-api/getAgentExecution-api-design.html): Business API Design Specification - `Get Agentexecution`
#### AI Agents
- [workforceAssistant Agent](/document/docs/agentHub-service/ai-agents/workforceAssistant-agent-design.html): AI Agent Design Specification - `workforceAssistant`
- [workforceInsightGenerator Agent](/document/docs/agentHub-service/ai-agents/workforceInsightGenerator-agent-design.html): AI Agent Design Specification - `workforceInsightGenerator`

### Bff Service

- [Service Design](/document/docs/bff-service/service-design.html): ---
- [REST API Guide](/document/docs/bff-service/rest-api-guide.html): Documentation
- [Event Guide](/document/docs/bff-service/event-guide.html): Documentation

### Notification Service

- [Service Design](/document/docs/notification-service/service-design.html): Provider-specific errors include stack traces
- [REST API Guide](/document/docs/notification-service/rest-api-guide.html): Documentation
- [Event Guide](/document/docs/notification-service/event-guide.html): Documentation

### LLM Documents

- [Documentation Index](/document/docs/llm/llms.html): Documentation
- [Complete Documentation](/document/docs/llm/llms-full.html): Documentation
- [REST API Reference](/document/docs/llm/llms-restapi.html): Documentation
- [Frontend Prompts](/document/docs/llm/llms-prompts.html): Documentation


## API Endpoints Summary

### workforceos-auth-service Service
- `POST /auth-api/getUser` - getUser
- `POST /auth-api/updateUser` - updateUser
- `POST /auth-api/updateProfile` - updateProfile
- `POST /auth-api/createUser` - createUser
- `POST /auth-api/deleteUser` - deleteUser
- `POST /auth-api/archiveProfile` - archiveProfile
- `POST /auth-api/listUsers` - listUsers
- `POST /auth-api/searchUsers` - searchUsers
- `POST /auth-api/updateUserRole` - updateUserRole
- `POST /auth-api/updateUserPassword` - updateUserPassword
- `POST /auth-api/updateUserPasswordByAdmin` - updateUserPasswordByAdmin
- `POST /auth-api/getBriefUser` - getBriefUser
- `POST /auth-api/streamTest` - streamTest
- `POST /auth-api/registerCompanyOwner` - registerCompanyOwner
- `POST /auth-api/registerCompanyUser` - registerCompanyUser
- `POST /auth-api/createCompany` - createCompany
- `POST /auth-api/getCompany` - getCompany
- `POST /auth-api/getCompanyHome` - getCompanyHome
- `POST /auth-api/getCompanyProfile` - getCompanyProfile
- `POST /auth-api/getCompanyAccount` - getCompanyAccount
- `POST /auth-api/listCompaniesAccounts` - listCompaniesAccounts
- `POST /auth-api/listBriefCompanies` - listBriefCompanies
- `POST /auth-api/getBriefCompany` - getBriefCompany
- `POST /auth-api/updateCompany` - updateCompany
- `POST /auth-api/deleteCompany` - deleteCompany
- `POST /auth-api/createUserGroup` - createUserGroup
- `POST /auth-api/updateUserGroup` - updateUserGroup
- `POST /auth-api/deleteUserGroup` - deleteUserGroup
- `POST /auth-api/getUserGroup` - getUserGroup
- `POST /auth-api/listUserGroups` - listUserGroups
- `POST /auth-api/getUserGroupMember` - getUserGroupMember
- `POST /auth-api/createUserGroupMember` - createUserGroupMember
- `POST /auth-api/deleteUserGroupMember` - deleteUserGroupMember
- `POST /auth-api/listUserGroupMembers` - listUserGroupMembers
- `POST /auth-api/getUserAvatarsFile` - getUserAvatarsFile
- `POST /auth-api/listUserAvatarsFiles` - listUserAvatarsFiles
- `POST /auth-api/deleteUserAvatarsFile` - deleteUserAvatarsFile
- `POST /auth-api/getCompanyAvatarsFile` - getCompanyAvatarsFile
- `POST /auth-api/listCompanyAvatarsFiles` - listCompanyAvatarsFiles
- `POST /auth-api/deleteCompanyAvatarsFile` - deleteCompanyAvatarsFile
- `POST /auth-api/_fetchListCompany` - _fetchListCompany
- `POST /auth-api/_fetchListUserAvatarsFile` - _fetchListUserAvatarsFile
- `POST /auth-api/_fetchListCompanyAvatarsFile` - _fetchListCompanyAvatarsFile

### workforceos-employeeprofile-service Service
- `POST /employeeProfile-api/createEmployeeProfile` - createEmployeeProfile
- `POST /employeeProfile-api/updateEmployeeProfile` - updateEmployeeProfile
- `POST /employeeProfile-api/getEmployeeProfile` - getEmployeeProfile
- `POST /employeeProfile-api/listEmployeeProfiles` - listEmployeeProfiles
- `POST /employeeProfile-api/createEmployeeDocument` - createEmployeeDocument
- `POST /employeeProfile-api/updateEmployeeDocument` - updateEmployeeDocument
- `POST /employeeProfile-api/getEmployeeDocument` - getEmployeeDocument
- `POST /employeeProfile-api/listEmployeeDocuments` - listEmployeeDocuments
- `POST /employeeProfile-api/deleteEmployeeProfile` - deleteEmployeeProfile
- `POST /employeeProfile-api/deleteEmployeeDocument` - deleteEmployeeDocument
- `POST /employeeProfile-api/_fetchListEmployeeProfile` - _fetchListEmployeeProfile
- `POST /employeeProfile-api/_fetchListEmployeeDocument` - _fetchListEmployeeDocument

### workforceos-schedulemanagement-service Service
- `POST /scheduleManagement-api/createShiftTemplate` - createShiftTemplate
- `POST /scheduleManagement-api/updateShiftTemplate` - updateShiftTemplate
- `POST /scheduleManagement-api/deleteShiftTemplate` - deleteShiftTemplate
- `POST /scheduleManagement-api/getShiftTemplate` - getShiftTemplate
- `POST /scheduleManagement-api/listShiftTemplates` - listShiftTemplates
- `POST /scheduleManagement-api/createShift` - createShift
- `POST /scheduleManagement-api/updateShift` - updateShift
- `POST /scheduleManagement-api/deleteShift` - deleteShift
- `POST /scheduleManagement-api/getShift` - getShift
- `POST /scheduleManagement-api/listShifts` - listShifts
- `POST /scheduleManagement-api/_fetchListShiftTemplate` - _fetchListShiftTemplate
- `POST /scheduleManagement-api/_fetchListShift` - _fetchListShift

### workforceos-attendancemanagement-service Service
- `POST /attendanceManagement-api/checkInAttendance` - checkInAttendance
- `POST /attendanceManagement-api/checkOutAttendance` - checkOutAttendance
- `POST /attendanceManagement-api/markAttendanceAbsent` - markAttendanceAbsent
- `POST /attendanceManagement-api/getAttendanceRecord` - getAttendanceRecord
- `POST /attendanceManagement-api/listAttendanceRecords` - listAttendanceRecords
- `POST /attendanceManagement-api/_fetchListAttendanceRecord` - _fetchListAttendanceRecord

### workforceos-taskmanagement-service Service
- `POST /taskManagement-api/createTaskAssignment` - createTaskAssignment
- `POST /taskManagement-api/listMyIndividualTasks` - listMyIndividualTasks
- `POST /taskManagement-api/getTaskAssignmentWithProgress` - getTaskAssignmentWithProgress
- `POST /taskManagement-api/getMyIndividualTask` - getMyIndividualTask
- `POST /taskManagement-api/listTaskAssignments` - listTaskAssignments
- `POST /taskManagement-api/deleteTaskAssignment` - deleteTaskAssignment
- `POST /taskManagement-api/updateIndividualTask` - updateIndividualTask
- `POST /taskManagement-api/updateTaskAssignment` - updateTaskAssignment
- `POST /taskManagement-api/createIndividualTask` - createIndividualTask
- `POST /taskManagement-api/deleteIndividualTask` - deleteIndividualTask
- `POST /taskManagement-api/_fetchListTaskAssignment` - _fetchListTaskAssignment
- `POST /taskManagement-api/_fetchListIndividualTask` - _fetchListIndividualTask

### workforceos-leavemanagement-service Service
- `POST /leaveManagement-api/createLeaveRequest` - createLeaveRequest
- `POST /leaveManagement-api/updateLeaveRequest` - updateLeaveRequest
- `POST /leaveManagement-api/deleteLeaveRequest` - deleteLeaveRequest
- `POST /leaveManagement-api/getLeaveRequest` - getLeaveRequest
- `POST /leaveManagement-api/listLeaveRequests` - listLeaveRequests
- `POST /leaveManagement-api/listMyLeaveRequests` - listMyLeaveRequests
- `POST /leaveManagement-api/getMyLeaveRequest` - getMyLeaveRequest
- `POST /leaveManagement-api/_fetchListLeaveRequest` - _fetchListLeaveRequest

### workforceos-payrollreporting-service Service
- `POST /payrollReporting-api/createPayrollReport` - createPayrollReport
- `POST /payrollReporting-api/updatePayrollReport` - updatePayrollReport
- `POST /payrollReporting-api/getPayrollReport` - getPayrollReport
- `POST /payrollReporting-api/listPayrollReports` - listPayrollReports
- `POST /payrollReporting-api/_fetchListPayrollReport` - _fetchListPayrollReport

### workforceos-announcementmanagement-service Service
- `POST /announcementManagement-api/createAnnouncement` - createAnnouncement
- `POST /announcementManagement-api/updateAnnouncement` - updateAnnouncement
- `POST /announcementManagement-api/deleteAnnouncement` - deleteAnnouncement
- `POST /announcementManagement-api/getAnnouncement` - getAnnouncement
- `POST /announcementManagement-api/listAnnouncements` - listAnnouncements
- `POST /announcementManagement-api/processScheduledAnnouncements` - processScheduledAnnouncements
- `POST /announcementManagement-api/_fetchListAnnouncement` - _fetchListAnnouncement

### workforceos-aiworkforceanalytics-service Service
- `POST /aiWorkforceAnalytics-api/createAiInsight` - createAiInsight
- `POST /aiWorkforceAnalytics-api/getAiInsight` - getAiInsight
- `POST /aiWorkforceAnalytics-api/listAiInsights` - listAiInsights
- `POST /aiWorkforceAnalytics-api/saveInsight` - saveInsight
- `POST /aiWorkforceAnalytics-api/saveAiInsight` - saveAiInsight
- `POST /aiWorkforceAnalytics-api/_fetchListAiInsight` - _fetchListAiInsight

### workforceos-subscriptionmanagement-service Service
- `POST /subscriptionManagement-api/createCompanySubscription` - createCompanySubscription
- `POST /subscriptionManagement-api/updateCompanySubscription` - updateCompanySubscription
- `POST /subscriptionManagement-api/getCompanySubscription` - getCompanySubscription
- `POST /subscriptionManagement-api/listCompanySubscriptions` - listCompanySubscriptions
- `POST /subscriptionManagement-api/deleteCompanySubscription` - deleteCompanySubscription
- `POST /subscriptionManagement-api/cancelCompanySubscription` - cancelCompanySubscription
- `POST /subscriptionManagement-api/getCompanySubscriptionPayment` - getCompanySubscriptionPayment
- `POST /subscriptionManagement-api/listCompanySubscriptionPayments` - listCompanySubscriptionPayments
- `POST /subscriptionManagement-api/createCompanySubscriptionPayment` - createCompanySubscriptionPayment
- `POST /subscriptionManagement-api/updateCompanySubscriptionPayment` - updateCompanySubscriptionPayment
- `POST /subscriptionManagement-api/deleteCompanySubscriptionPayment` - deleteCompanySubscriptionPayment
- `POST /subscriptionManagement-api/getCompanySubscriptionPaymentByOrderId` - getCompanySubscriptionPaymentByOrderId
- `POST /subscriptionManagement-api/getCompanySubscriptionPaymentByPaymentId` - getCompanySubscriptionPaymentByPaymentId
- `POST /subscriptionManagement-api/startCompanySubscriptionPayment` - startCompanySubscriptionPayment
- `POST /subscriptionManagement-api/refreshCompanySubscriptionPayment` - refreshCompanySubscriptionPayment
- `POST /subscriptionManagement-api/callbackCompanySubscriptionPayment` - callbackCompanySubscriptionPayment
- `POST /subscriptionManagement-api/getPaymentCustomerByUserId` - getPaymentCustomerByUserId
- `POST /subscriptionManagement-api/listPaymentCustomers` - listPaymentCustomers
- `POST /subscriptionManagement-api/listPaymentCustomerMethods` - listPaymentCustomerMethods
- `POST /subscriptionManagement-api/_fetchListCompanySubscription` - _fetchListCompanySubscription
- `POST /subscriptionManagement-api/_fetchListSys_companySubscriptionPayment` - _fetchListSys_companySubscriptionPayment
- `POST /subscriptionManagement-api/_fetchListSys_paymentCustomer` - _fetchListSys_paymentCustomer
- `POST /subscriptionManagement-api/_fetchListSys_paymentMethod` - _fetchListSys_paymentMethod

### workforceos-agenthub-service Service
- `POST /agentHub-api/getAgentOverride` - getAgentOverride
- `POST /agentHub-api/listAgentOverrides` - listAgentOverrides
- `POST /agentHub-api/updateAgentOverride` - updateAgentOverride
- `POST /agentHub-api/createAgentOverride` - createAgentOverride
- `POST /agentHub-api/deleteAgentOverride` - deleteAgentOverride
- `POST /agentHub-api/listToolCatalog` - listToolCatalog
- `POST /agentHub-api/getToolCatalogEntry` - getToolCatalogEntry
- `POST /agentHub-api/listAgentExecutions` - listAgentExecutions
- `POST /agentHub-api/getAgentExecution` - getAgentExecution
- `POST /agentHub-api/_fetchListSys_agentOverride` - _fetchListSys_agentOverride
- `POST /agentHub-api/_fetchListSys_agentExecution` - _fetchListSys_agentExecution
- `POST /agentHub-api/_fetchListSys_toolCatalog` - _fetchListSys_toolCatalog


## Getting Started

1. **Authentication**: Start with the Auth Service to register and authenticate users
2. **Data Queries**: Use the BFF Service for optimized read-only data queries
3. **Business Operations**: Use individual business services for create/update/delete operations

## Additional Resources

- Full documentation: /document/docs/intro.html
- Search: /document/docs/search.html

---
Generated by Mindbricks Genesis Engine