API Reference

Endpoint Organization

Prefix Module
/api/v1/auth Authentication
/api/v1/users User management
/api/v1/roles Role management
/api/v1/organizations Organizations
/api/v1/farm/areas Farm areas
/api/v1/farm/ponds Ponds
/api/v1/aquaculture/species Species
/api/v1/aquaculture/cycles Farming cycles
/api/v1/aquaculture/daily-logs Daily logs
/api/v1/aquaculture/growth-records Growth records
/api/v1/devices Device management
/api/v1/telemetry Telemetry data
/api/v1/alerts Alert management (under devices module)
/api/v1/alert-configs Alert configurations
/api/v1/inventory Inventory management
/api/v1/suppliers Supplier management
/api/v1/reports Reports & analytics
/api/v1/notifications User notifications
/api/v1/financial/cost-categories Cost categories
/api/v1/financial/expenses Expense records
/api/v1/financial/revenues Revenue records
/api/v1/financial/recurring-expenses Recurring expenses
/api/v1/financial/reports Financial reports

API Response Format

// Success
{
  "data": { ... },
  "message": "Success"
}

// Paginated
{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5
  }
}

Authentication Endpoints

Method Endpoint Description
POST /auth/register Register new user
POST /auth/login Login (returns JWT + httpOnly cookie)
POST /auth/logout Logout (clears cookie)
POST /auth/refresh Refresh access token
POST /auth/forgot-password Request password reset
POST /auth/reset-password Reset password with token
GET /auth/me Get current user data

Last updated: March 2026