GET); the Residents endpoint additionally supports creating and updating records (POST/PUT). Authenticate by exchanging your API key for a JWT token via POST /openapi/auth/token/exchange, then include the token in the Authorization: Bearer header.\n\nToken Exchange (Required): Exchange the API key for a short-lived JWT token (15 minutes) using POST /openapi/auth/token/exchange. This provides enhanced security by minimizing API key exposure.
All authenticated endpoints require a valid JWT token in the Authorization: Bearer header.
GET /health - System health check (no authentication required)GET /openapi/health - Alternative health check path (legacy compatibility)GET /openapi/api/residents - List all residents with filtering and paginationGET /openapi/api/residents/:id - Get specific resident by IDPOST /openapi/api/residents - Create a residentPUT /openapi/api/residents/:id - Update a residenthomeId, residentId, startDate, endDate, dateField, page, limitGET /openapi/api/careplans - List all care plans with filteringGET /openapi/api/careplans/:id - Get specific care plan by IDhomeId, residentId, carePlanId, startDate, endDate, dateField, page, limitGET /openapi/api/goals - List all goals with filteringGET /openapi/api/goals/:id - Get specific goal by IDhomeId, residentId, startDate, endDate, dateField, page, limitGET /openapi/api/incident-reports - List all incident reportsGET /openapi/api/incident-reports/:id - Get specific incident report by IDhomeId, residentId, severity, startDate, endDate, dateField, page, limitGET /openapi/api/risk-assessments - List all risk assessmentsGET /openapi/api/risk-assessments/:id - Get specific risk assessment by IDhomeId, residentId, startDate, endDate, dateField, page, limitGET /openapi/api/homes - List all care homesGET /openapi/api/homes/:id - Get specific home by IDpage, limitGET /openapi/api/users - List all usersGET /openapi/api/users/:id - Get specific user by IDstartDate, endDate, dateField, page, limitGET /openapi/api/logs - List all daily care logsGET /openapi/api/logs/:id - Get specific log by IDhomeId, residentId, categoryId, itemId, loggedById, startDate, endDate, dateField, page, limitGET /openapi/api/logcategories - List all log categories (no authentication required)GET /openapi/api/logcategories/:id - Get specific log category by ID (no authentication required)page, limitGET /openapi/api/logcategoryitems - List all log category items (no authentication required)GET /openapi/api/logcategoryitems/:id - Get specific log category item by ID (no authentication required)page, limitGET /openapi/api/documents - List all resident documentsGET /openapi/api/documents/:id - Get specific document by IDhomeId, residentId, categoryId, startDate, endDate, dateField, page, limitGET /openapi/api/home-documents - List all home-scoped documentsGET /openapi/api/home-documents/:id - Get specific home document by IDhomeId, categoryId, startDate, endDate, dateField, page, limitGET /openapi/api/devices - List all devices (tablets, phones, laptops)GET /openapi/api/devices/:id - Get specific device by IDtype, deviceStatus, startDate, endDate, page, limitPagination: All list endpoints support page (default: 1) and limit (default: 10, max: 100) parameters.
Date Filtering: Many endpoints support startDate, endDate, and dateField parameters for filtering by date ranges.
Rate limits: 100 requests/minute per IP (unauthenticated), 1,000 requests/minute with JWT token authentication.
\n\nSecurity: All requests logged, input validated, parameterised queries, rate limiting enforced.
"}},"baseSlug":"/docs/openapi","routesMapping":{}}