Endpoint Reference
A comprehensive listing of all API endpoints grouped by module. For interactive documentation with request/response examples, see the Scramble docs when the backend is running.
Authentication
| Method | Endpoint | Description |
|---|---|---|
| GET | /sanctum/csrf-cookie | Get CSRF token cookie |
| POST | /api/login | Sign in |
| POST | /api/logout | Sign out |
| GET | /api/user | Get authenticated user |
Profile
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/profile | Get current user profile |
| PUT | /api/profile | Update profile (name) |
| PUT | /api/profile/password | Change password |
Dashboard
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/dashboard | Get dashboard summary stats |
Entities
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/entities | List entities (paginated) |
| POST | /api/entities | Create entity |
| GET | /api/entities/{id} | Get entity details |
| PUT | /api/entities/{id} | Update entity |
| DELETE | /api/entities/{id} | Delete entity |
| GET | /api/entities/export/csv | Export entities to CSV |
Departments
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/departments | List departments (paginated, filterable) |
| POST | /api/departments | Create department |
| GET | /api/departments/{id} | Get department details |
| PUT | /api/departments/{id} | Update department |
| DELETE | /api/departments/{id} | Delete department |
| PUT | /api/departments/{id}/managers | Assign managers |
| PUT | /api/departments/{id}/team-leads | Assign team leads |
| GET | /api/departments/export/csv | Export departments to CSV |
Employees
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/employees | List employees (paginated, filterable, searchable) |
| POST | /api/employees | Create employee (employee number auto-generated) |
| GET | /api/employees/{id} | Get employee details |
| PUT | /api/employees/{id} | Update employee |
| POST | /api/employees/{id}/profile-picture | Upload profile picture |
| DELETE | /api/employees/{id}/profile-picture | Remove profile picture |
| GET | /api/employees/{id}/attachments | List attachments |
| POST | /api/employees/{id}/attachments | Upload attachment |
| GET | /api/employees/{id}/attachments/{aid}/download | Download attachment |
| DELETE | /api/employees/{id}/attachments/{aid} | Delete attachment |
| GET | /api/employees/export/csv | Export employees to CSV |
| POST | /api/employees/import | Import employees from CSV (employee_number optional) |
KPI Templates
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/kpi-templates | List templates |
| POST | /api/kpi-templates | Create template with items |
| GET | /api/kpi-templates/{id} | Get template details |
| PUT | /api/kpi-templates/{id} | Update template |
| DELETE | /api/kpi-templates/{id} | Delete template |
| POST | /api/kpi-templates/import | Import templates from CSV |
KPI Cycles
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/kpi-cycles | List cycles |
| POST | /api/kpi-cycles | Create cycle |
| GET | /api/kpi-cycles/{id} | Get cycle details with department status |
| PUT | /api/kpi-cycles/{id} | Update cycle |
| DELETE | /api/kpi-cycles/{id} | Delete cycle |
| POST | /api/kpi-cycles/{id}/departments/{deptId}/assign-template | Assign template to department |
| POST | /api/kpi-cycles/{id}/departments/{deptId}/publish | Publish department evaluations |
| GET | /api/kpi-cycles/{id}/export/csv | Finance KPI score export |
KPI Evaluations
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/kpi-evaluations | List evaluations (role-scoped) |
| GET | /api/kpi-evaluations/{id} | Get evaluation detail with scores |
| POST | /api/kpi-evaluations/{id}/self-assess | Submit self-assessment scores |
| POST | /api/kpi-evaluations/{id}/review | Submit manager review scores |
| POST | /api/kpi-evaluations/{id}/hr-review | Submit HR review |
| POST | /api/kpi-evaluations/{id}/accept | Employee accepts evaluation |
| POST | /api/kpi-evaluations/{id}/dispute | Employee disputes evaluation |
| POST | /api/kpi-evaluations/{id}/complete | HR force-closes evaluation |
| PUT | /api/kpi-evaluations/{id}/assign-reviewer | Assign/reassign reviewer |
| POST | /api/kpi-evaluations/{id}/attachments | Upload evidence |
| GET | /api/kpi-evaluations/{id}/attachments/{aid}/download | Download evidence |
| DELETE | /api/kpi-evaluations/{id}/attachments/{aid} | Delete evidence |
Probation Reviews
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/probation-reviews | List reviews (role-scoped) |
| POST | /api/probation-reviews | Create review |
| GET | /api/probation-reviews/{id} | Get review detail |
| POST | /api/probation-reviews/{id}/submit | Manager submits review |
| POST | /api/probation-reviews/{id}/approve | HR approves review |
| POST | /api/probation-reviews/{id}/send-back | HR sends back review |