Introduction
Welcome to the Cutikuy API documentation. This API provides endpoints for managing
leave requests, users, and other core data for the Cutikuy application. All responses follow a
consistent structure defined by our ResponseFormatter.
Base URL
You can set your API's base URL in the input box in the left sidebar. It will be used to generate the code examples.
How to Send Data
In each endpoint's parameter table, the 'Location' column tells you where to put your data. Here’s what each value means:
- path: The data
is part of the URL path itself (e.g., the user ID in
/api/admin/master/users/123). The code examples automatically place this in the URL. - body: The data
should be sent in the request body. For POST, PUT, and PATCH requests, this is typically a JSON
object. If a file is involved, the request is sent as
multipart/form-data. The code examples show the correct format.
Authentication
Public endpoints for user registration, login, and password management.
User Profile
Endpoint for the authenticated user.
Leave Requests (User)
Endpoints for employees to manage their own leave requests - view, create, and update.
Approver Actions
Endpoints for managers and approvers to review and approve/reject leave requests.
Admin: Dashboard
Endpoints for fetching aggregated data for the admin dashboard.
Admin: Users
Endpoints for managing users.
Admin: Departments
Endpoints for managing departments.
Admin: Leave Types
Endpoints for managing leave types.
Admin: Public Holidays
Endpoints for managing public holidays.
Admin: Employee Entitlements
Endpoints for managing employee entitlements.
Admin: Leave Requests
Endpoints for managing all leave requests.