Skip to main content

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

MethodEndpointDescription
GET/sanctum/csrf-cookieGet CSRF token cookie
POST/api/loginSign in
POST/api/logoutSign out
GET/api/userGet authenticated user

Profile

MethodEndpointDescription
GET/api/profileGet current user profile
PUT/api/profileUpdate profile (name)
PUT/api/profile/passwordChange password

Dashboard

MethodEndpointDescription
GET/api/dashboardGet dashboard summary stats

Entities

MethodEndpointDescription
GET/api/entitiesList entities (paginated)
POST/api/entitiesCreate entity
GET/api/entities/{id}Get entity details
PUT/api/entities/{id}Update entity
DELETE/api/entities/{id}Delete entity
GET/api/entities/export/csvExport entities to CSV

Departments

MethodEndpointDescription
GET/api/departmentsList departments (paginated, filterable)
POST/api/departmentsCreate department
GET/api/departments/{id}Get department details
PUT/api/departments/{id}Update department
DELETE/api/departments/{id}Delete department
PUT/api/departments/{id}/managersAssign managers
PUT/api/departments/{id}/team-leadsAssign team leads
GET/api/departments/export/csvExport departments to CSV

Employees

MethodEndpointDescription
GET/api/employeesList employees (paginated, filterable, searchable)
POST/api/employeesCreate employee (employee number auto-generated)
GET/api/employees/{id}Get employee details
PUT/api/employees/{id}Update employee
POST/api/employees/{id}/profile-pictureUpload profile picture
DELETE/api/employees/{id}/profile-pictureRemove profile picture
GET/api/employees/{id}/attachmentsList attachments
POST/api/employees/{id}/attachmentsUpload attachment
GET/api/employees/{id}/attachments/{aid}/downloadDownload attachment
DELETE/api/employees/{id}/attachments/{aid}Delete attachment
GET/api/employees/export/csvExport employees to CSV
POST/api/employees/importImport employees from CSV (employee_number optional)

KPI Templates

MethodEndpointDescription
GET/api/kpi-templatesList templates
POST/api/kpi-templatesCreate 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/importImport templates from CSV

KPI Cycles

MethodEndpointDescription
GET/api/kpi-cyclesList cycles
POST/api/kpi-cyclesCreate 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-templateAssign template to department
POST/api/kpi-cycles/{id}/departments/{deptId}/publishPublish department evaluations
GET/api/kpi-cycles/{id}/export/csvFinance KPI score export

KPI Evaluations

MethodEndpointDescription
GET/api/kpi-evaluationsList evaluations (role-scoped)
GET/api/kpi-evaluations/{id}Get evaluation detail with scores
POST/api/kpi-evaluations/{id}/self-assessSubmit self-assessment scores
POST/api/kpi-evaluations/{id}/reviewSubmit manager review scores
POST/api/kpi-evaluations/{id}/hr-reviewSubmit HR review
POST/api/kpi-evaluations/{id}/acceptEmployee accepts evaluation
POST/api/kpi-evaluations/{id}/disputeEmployee disputes evaluation
POST/api/kpi-evaluations/{id}/completeHR force-closes evaluation
PUT/api/kpi-evaluations/{id}/assign-reviewerAssign/reassign reviewer
POST/api/kpi-evaluations/{id}/attachmentsUpload evidence
GET/api/kpi-evaluations/{id}/attachments/{aid}/downloadDownload evidence
DELETE/api/kpi-evaluations/{id}/attachments/{aid}Delete evidence

Probation Reviews

MethodEndpointDescription
GET/api/probation-reviewsList reviews (role-scoped)
POST/api/probation-reviewsCreate review
GET/api/probation-reviews/{id}Get review detail
POST/api/probation-reviews/{id}/submitManager submits review
POST/api/probation-reviews/{id}/approveHR approves review
POST/api/probation-reviews/{id}/send-backHR sends back review

Notifications

MethodEndpointDescription
GET/api/notificationsList user notifications
GET/api/notifications/unread-countGet unread count
POST/api/notifications/{id}/mark-readMark one as read
POST/api/notifications/mark-all-readMark all as read

Notification Settings

MethodEndpointDescription
GET/api/notification-settingsGet settings
PUT/api/notification-settingsUpdate settings

Roles & Permissions

MethodEndpointDescription
GET/api/rolesList roles
POST/api/rolesCreate role
GET/api/roles/{id}Get role details
PUT/api/roles/{id}Update role
DELETE/api/roles/{id}Delete role
PUT/api/roles/{id}/permissionsSync role permissions
GET/api/permissionsList all permissions

Actionable Items

MethodEndpointDescription
GET/api/actionable-itemsList pending user actions
GET/api/actionable-items/countGet pending count

Lookup Endpoints

MethodEndpointDescription
GET/api/entities/allAll entities (no pagination)
GET/api/departments/allAll departments (no pagination)
GET/api/employees/allAll employees (no pagination)
GET/api/kpi-templates/allAll templates (no pagination)