Endpoint
Description
Retrieve a paginated list of memos for the authenticated user’s company. Supports filtering by employee, status, and memo type.
Authentication
Requires Bearer token authentication. Accessible by:
- Employee
- Manager
- HR Manager
- Super Admin
Query Parameters
Page number for pagination
Filter memos by employee UUID (creator of the memo)
Filter by memo status. Valid values:
draftpendingapprovedrejectedarchived
Filter by memo type. Valid values:
requestdisciplinaryannouncementgeneral
Response
Indicates if the request was successful
Paginated memo list
Array of memo objects
Unique memo identifier (UUID)
UUID of the employee who created the memo
Type of memo (request, disciplinary, announcement, general)
Reference number for tracking
Current approval workflow step
Priority level (low, normal, high, urgent)
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
Total number of memos matching the filters
Example Request
GET /memos?page=1&pageSize=20&status=pending&memoType=request
Example Response
{
"success": true,
"data": {
"memos": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"employeeId": "660e8400-e29b-41d4-a716-446655440000",
"memoType": "request",
"title": "Request for Additional Resources",
"content": "We require additional development resources for the Q2 project.",
"referenceNumber": "REQ-2024-001",
"status": "pending",
"currentStep": 1,
"priority": "high",
"createdAt": "2024-03-03T10:30:00Z",
"updatedAt": "2024-03-03T10:30:00Z"
},
{
"id": "223e4567-e89b-12d3-a456-426614174001",
"companyId": "550e8400-e29b-41d4-a716-446655440000",
"employeeId": "770e8400-e29b-41d4-a716-446655440001",
"memoType": "request",
"title": "Equipment Upgrade Request",
"content": "Request for new laptops for the design team.",
"referenceNumber": "REQ-2024-002",
"status": "pending",
"currentStep": 2,
"priority": "normal",
"createdAt": "2024-03-02T14:20:00Z",
"updatedAt": "2024-03-03T09:15:00Z"
}
],
"page": 1,
"pageSize": 20,
"total": 2,
"totalPages": 1
}
}
Status Codes
Memos retrieved successfully
Missing or invalid authentication token
Filtering Examples
GET /memos?status=pending
Combine multiple filters to narrow down results. For example, filter by both status=pending and memoType=request to see all pending request memos.