IV

Inua Village Group

Backend API Documentation

97
API Endpoints
7
Categories
3
Schools
12+
Products
10
Test Users
MethodEndpointDescriptionCategory
GET/api/hubGet organization info, impact metrics, subsidiariesHub Portal
POST/api/hubUpdate organization info (admin)Hub Portal
GET/api/hub/newsList news articles (paginated, filterable)Hub Portal
POST/api/hub/newsCreate news article (admin)Hub Portal
GET/api/hub/news/[id]Get article by ID or slugHub Portal
PUT/api/hub/news/[id]Update articleHub Portal
DELETE/api/hub/news/[id]Delete articleHub Portal
GET/api/hub/teamList team membersHub Portal
POST/api/hub/teamAdd team member (admin)Hub Portal
GET/api/hub/careersList career openingsHub Portal
POST/api/hub/careersCreate job opening (admin)Hub Portal
GET/api/hub/partnershipsList partnershipsHub Portal
POST/api/hub/partnershipsAdd partnership (admin)Hub Portal
GET/api/hub/impactGet impact metricsHub Portal
POST/api/hub/impactAdd impact metric (admin)Hub Portal
GET/api/schoolsList all schools (filterable)Schools Network
POST/api/schoolsCreate new school (admin)Schools Network
GET/api/schools/[id]Get school details with programs, facultySchools Network
PUT/api/schools/[id]Update school infoSchools Network
DELETE/api/schools/[id]Deactivate schoolSchools Network
GET/api/schools/[id]/programsList school programsSchools Network
POST/api/schools/[id]/programsAdd program (admin)Schools Network
GET/api/schools/[id]/facultyList faculty membersSchools Network
POST/api/schools/[id]/facultyAdd faculty (admin)Schools Network
GET/api/schools/[id]/facilitiesList facilitiesSchools Network
GET/api/schools/[id]/achievementsList achievementsSchools Network
GET/api/schools/[id]/eventsList eventsSchools Network
GET/api/schools/[id]/galleryList gallery itemsSchools Network
GET/api/schools/applicationsList admission applicationsSchools Network
POST/api/schools/applicationsSubmit applicationSchools Network
PATCH/api/schools/applications/[id]/statusUpdate application statusSchools Network
GET/api/textiles/categoriesList product categoriesTextiles E-commerce
POST/api/textiles/categoriesCreate category (admin)Textiles E-commerce
GET/api/textiles/productsList products (filterable, searchable)Textiles E-commerce
POST/api/textiles/productsCreate product (admin)Textiles E-commerce
GET/api/textiles/products/[id]Get product with variants, reviewsTextiles E-commerce
PUT/api/textiles/products/[id]Update product (admin)Textiles E-commerce
GET/api/textiles/products/[id]/imagesList product imagesTextiles E-commerce
GET/api/textiles/products/[id]/variantsList product variantsTextiles E-commerce
GET/api/textiles/products/[id]/reviewsList product reviewsTextiles E-commerce
POST/api/textiles/products/[id]/reviewsAdd review (authenticated)Textiles E-commerce
GET/api/textiles/cartGet user's cartTextiles E-commerce
POST/api/textiles/cartAdd item to cartTextiles E-commerce
DELETE/api/textiles/cartClear cartTextiles E-commerce
GET/api/textiles/wishlistGet user's wishlistTextiles E-commerce
POST/api/textiles/wishlistAdd to wishlistTextiles E-commerce
GET/api/textiles/ordersList ordersTextiles E-commerce
POST/api/textiles/ordersCreate order from cartTextiles E-commerce
GET/api/textiles/orders/[id]Get order detailsTextiles E-commerce
PATCH/api/textiles/orders/[id]Update order/payment statusTextiles E-commerce
GET/api/sacco/configGet SACCO configurationSACCO Financial
PUT/api/sacco/configUpdate config (super admin)SACCO Financial
GET/api/sacco/membershipsList membershipsSACCO Financial
POST/api/sacco/membershipsApply for membershipSACCO Financial
GET/api/sacco/memberships/[id]Get membership detailsSACCO Financial
PATCH/api/sacco/memberships/[id]Update membership statusSACCO Financial
GET/api/sacco/accountsList accountsSACCO Financial
POST/api/sacco/accountsOpen new accountSACCO Financial
GET/api/sacco/accounts/[id]Get account with transactionsSACCO Financial
GET/api/sacco/loansList loansSACCO Financial
POST/api/sacco/loansApply for loanSACCO Financial
GET/api/sacco/loans/[id]Get loan with repayment scheduleSACCO Financial
PATCH/api/sacco/loans/[id]Approve/reject/disburse loanSACCO Financial
GET/api/sacco/loans/[id]/repaymentsGet repayment scheduleSACCO Financial
POST/api/sacco/loans/[id]/repaymentsMake loan paymentSACCO Financial
GET/api/sacco/transactionsList transactions (filterable)SACCO Financial
POST/api/sacco/transactionsRecord deposit/withdrawalSACCO Financial
GET/api/sacco/statisticsGet SACCO dashboard statisticsSACCO Financial
GET/api/farm/productsList farm products (filterable)Farm Agricultural
POST/api/farm/productsCreate product (admin)Farm Agricultural
GET/api/farm/products/[id]Get product with reviewsFarm Agricultural
PUT/api/farm/products/[id]Update product (admin)Farm Agricultural
GET/api/farm/products/[id]/reviewsList product reviewsFarm Agricultural
POST/api/farm/products/[id]/reviewsAdd review (authenticated)Farm Agricultural
GET/api/farm/subscriptionsList subscriptionsFarm Agricultural
POST/api/farm/subscriptionsCreate subscriptionFarm Agricultural
GET/api/farm/subscriptions/[id]Get subscription detailsFarm Agricultural
PATCH/api/farm/subscriptions/[id]Pause/resume/cancel subscriptionFarm Agricultural
GET/api/farm/ordersList farm ordersFarm Agricultural
POST/api/farm/ordersCreate farm orderFarm Agricultural
GET/api/farm/orders/[id]Get order detailsFarm Agricultural
PATCH/api/farm/orders/[id]Update order statusFarm Agricultural
GET/api/farm/bookingsList bookings (visits, workshops)Farm Agricultural
POST/api/farm/bookingsCreate bookingFarm Agricultural
GET/api/farm/bookings/[id]Get booking detailsFarm Agricultural
PATCH/api/farm/bookings/[id]Confirm/cancel/complete bookingFarm Agricultural
GET/api/farm/resourcesList educational resourcesFarm Agricultural
POST/api/farm/resourcesCreate resource (admin)Farm Agricultural
GET/api/farm/resources/[id]Get resource contentFarm Agricultural
PATCH/api/farm/resources/[id]Increment view countFarm Agricultural
POST/api/auth/registerRegister new userAuthentication
POST/api/auth/loginUser loginAuthentication
POST/api/auth/logoutUser logoutAuthentication
GET/api/auth/meGet current userAuthentication
GET/api/auth/usersList users (admin)Authentication
GET/api/contactList inquiries (admin)Contact
POST/api/contactSubmit contact inquiryContact

Quick Start Guide

Authentication

// Login
POST /api/auth/login
{
  "email": "user1@example.com",
  "password": "Password123!"
}

// Response
{
  "success": true,
  "data": {
    "user": {...},
    "token": "session-token-here"
  }
}

Example Requests

// Get Schools
GET /api/schools?type=PRIMARY

// Get Products  
GET /api/textiles/products?featured=true

// Get SACCO Stats
GET /api/sacco/statistics

// Submit Application
POST /api/schools/applications
{
  "schoolId": "...",
  "studentFirstName": "John",
  ...
}