API Overview

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rampop01/HR-Platform/llms.txt

Use this file to discover all available pages before exploring further.

​

Introduction

​

Base URL

const PROXY_BASE = '/api/proxy'

• /api/auth/ - Authentication endpoints
• /api/v1/ - Core API endpoints

​

Proxy Setup

• Prevents CORS issues by keeping requests same-origin
• Centralizes authentication token handling
• Provides a consistent error handling layer

​

Making API Calls

async function apiCall<T>(
  endpoint: string,
  method: 'GET' | 'POST' = 'GET',
  body?: Record<string, unknown>,
  token?: string
): Promise<T>

​

Headers

• Accept: application/json - Required for all requests
• Authorization: Bearer {token} - Added when token is provided
• Content-Type: application/json - Added only for requests with a body

​

Response Handling

1. Validates that responses are JSON format
2. Throws errors for non-JSON responses
3. Extracts error messages from response body
4. Returns typed response data

​

Error Format

responseData?.message || responseData?.error || `API error: ${response.status}`

​

Authentication

headers['Authorization'] = `Bearer ${token}`

​

Available Endpoints

​

Authentication

• POST /api/auth/login - User login
• POST /api/v1/logout - User logout

​

Dashboard

• GET /api/v1/dashboard - Get dashboard metrics

​

Employees

• GET /api/v1/employee - List employees with pagination
• GET /api/v1/employee? - Search employees
• GET /api/v1/employee/ - Get employee details

​

Data Models

• Employee - Basic employee information
• EmployeeDetail - Extended employee information
• DashboardData - Dashboard metrics

​

Usage Example

import { api } from '@/lib/api'
import { auth } from '@/lib/auth'

// Login
const loginResponse = await api.login('user@example.com', 'password')
auth.saveSession({
  token: loginResponse.token,
  user: loginResponse.user
})

// Get dashboard data
const token = auth.getToken()
if (token) {
  const dashboard = await api.getDashboard(token)
  console.log(`Total employees: ${dashboard.total_employees}`)
  
  // Get employees
  const employees = await api.getEmployees(token, 1)
  console.log(`Found ${employees.total} employees`)
}