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
Event Guide – helpful for event-driven or cross-service integrations
Auth Event Guide
Service Design Document – overall structure, patterns, and logic
Auth Service Design

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
Event Guide – syncing strategies across replicas
BFF Event Guide
Service Design – aggregation patterns and index structures
BFF Service Design

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.

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

{
  "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):

{
  "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.