List Memos

Retrieve a paginated list of memos with filtering options

Endpoint

GET /memos

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 · integer · default: "1"

Page number for pagination

pageSize · integer · default: "10"

Number of memos per page

employeeId · string

Filter memos by employee UUID (creator of the memo)

status · string

Filter by memo status. Valid values:

• draft
• pending
• approved
• rejected
• archived

memoType · string

Filter by memo type. Valid values:

• request
• disciplinary
• announcement
• general

Response

success · boolean

Indicates if the request was successful

data · object

Paginated memo list

Show Pagination Data

memos · array

Array of memo objects

Show Memo Object

id · string

Unique memo identifier (UUID)

companyId · string

Company UUID

employeeId · string

UUID of the employee who created the memo

memoType · string

Type of memo (request, disciplinary, announcement, general)

title · string

Memo title

content · string

Full memo content

referenceNumber · string

Reference number for tracking

status · string

Current memo status

currentStep · integer

Current approval workflow step

priority · string

Priority level (low, normal, high, urgent)

createdAt · string

ISO 8601 timestamp of creation

updatedAt · string

ISO 8601 timestamp of last update

page · integer

Current page number

pageSize · integer

Number of items per page

total · integer

Total number of memos matching the filters

totalPages · integer

Total number of pages

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

200 · OK

Memos retrieved successfully

400 · Bad Request

Invalid query parameters

401 · Unauthorized

Missing or invalid authentication token

500 · Internal Server Error

Server error occurred

Filtering Examples

Get all pending memos

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.