API Overview

The HarborGuard API provides programmatic access to all platform features.

Base URL

https://your-instance.harborguard.com/api

Response Format

All API responses follow a consistent JSON structure:

{
  "data": { },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Error responses use a standard error envelope:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}