{"items":[{"type":"link","link":"","label":"Overview"},{"type":"link","label":"Log my Care Open API","link":"/docs/openapi/v1.101.0","routeSlug":"/docs/openapi/v1.101.0","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"health","link":"/docs/openapi/v1.101.0/health","routeSlug":"/docs/openapi/v1.101.0/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/health/gethealth","routeSlug":"/docs/openapi/v1.101.0/health/gethealth","metadata":{"seo":{"title":"Health check","description":"<p>Health check endpoint that returns the application status, uptime, and version information.</p><p>This endpoint is used by load balancers and monitoring systems.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/health","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"getHealthLegacy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/health/gethealthlegacy","routeSlug":"/docs/openapi/v1.101.0/health/gethealthlegacy","metadata":{"seo":{"title":"getHealthLegacy"}},"httpPath":"/openapi/health","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"token-exchange","link":"/docs/openapi/v1.101.0/token-exchange","routeSlug":"/docs/openapi/v1.101.0/token-exchange","items":[{"label":"Exchange API key for short-lived access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/token-exchange/exchangetoken","routeSlug":"/docs/openapi/v1.101.0/token-exchange/exchangetoken","metadata":{"seo":{"title":"Exchange API key for short-lived access token","description":"<p>Exchange a long-lived API key for a short-lived JWT access token (15 minutes).</p><p>This provides enhanced security by minimizing API key exposure.</p>"}},"httpPath":"/auth/token/exchange","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Residents","link":"/docs/openapi/v1.101.0/modules-residents","routeSlug":"/docs/openapi/v1.101.0/modules-residents","items":[{"label":"Get residents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-residents/getresidents","routeSlug":"/docs/openapi/v1.101.0/modules-residents/getresidents","metadata":{"seo":{"title":"Get residents","description":"<p>Retrieves residents with personal details, medical history, room location, and care preferences.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (e.g., createdOn, admissionDate)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/residents","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Create resident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-residents/createresident","routeSlug":"/docs/openapi/v1.101.0/modules-residents/createresident","metadata":{"seo":{"title":"Create resident","description":"Create resident"}},"httpPath":"/api/residents","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get resident by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-residents/getresidentbyid","routeSlug":"/docs/openapi/v1.101.0/modules-residents/getresidentbyid","metadata":{"seo":{"title":"Get resident by ID","description":"<p>Retrieves complete resident information including medical history, allergies, GP details, care preferences, and room location.</p>"}},"httpPath":"/api/residents/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Update resident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-residents/updateresident","routeSlug":"/docs/openapi/v1.101.0/modules-residents/updateresident","metadata":{"seo":{"title":"Update resident","description":"Update resident"}},"httpPath":"/api/residents/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Users","link":"/docs/openapi/v1.101.0/modules-users","routeSlug":"/docs/openapi/v1.101.0/modules-users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-users/getusers","routeSlug":"/docs/openapi/v1.101.0/modules-users/getusers","metadata":{"seo":{"title":"Get users","description":"<p>Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/users","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-users/createuser","routeSlug":"/docs/openapi/v1.101.0/modules-users/createuser","metadata":{"seo":{"title":"Create user","description":"Create user"}},"httpPath":"/api/users","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-users/getuserbyid","routeSlug":"/docs/openapi/v1.101.0/modules-users/getuserbyid","metadata":{"seo":{"title":"Get user by ID","description":"<p>Retrieves a complete user profile including roles, permissions, homeIds, and employment details. Password fields are excluded for security.</p>"}},"httpPath":"/api/users/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-users/updateuser","routeSlug":"/docs/openapi/v1.101.0/modules-users/updateuser","metadata":{"seo":{"title":"Update user","description":"Update user"}},"httpPath":"/api/users/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Care Plans","link":"/docs/openapi/v1.101.0/modules-care-plans","routeSlug":"/docs/openapi/v1.101.0/modules-care-plans","items":[{"label":"Get care plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-care-plans/getcareplans","routeSlug":"/docs/openapi/v1.101.0/modules-care-plans/getcareplans","metadata":{"seo":{"title":"Get care plans","description":"<p>Retrieves care plans with goals, assessments, documents, and tracking information.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>carePlanId</code> - Filter by care plan ID</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/careplans","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get care plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-care-plans/getcareplanbyid","routeSlug":"/docs/openapi/v1.101.0/modules-care-plans/getcareplanbyid","metadata":{"seo":{"title":"Get care plan by ID","description":"<p>Retrieves a complete care plan including goals, assessments, documents, risk assessments, and review history.</p>"}},"httpPath":"/api/careplans/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Homes","link":"/docs/openapi/v1.101.0/modules-homes","routeSlug":"/docs/openapi/v1.101.0/modules-homes","items":[{"label":"Get homes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-homes/gethomes","routeSlug":"/docs/openapi/v1.101.0/modules-homes/gethomes","metadata":{"seo":{"title":"Get homes","description":"<p>Retrieves care homes with facility details, ODS code, address, bed capacity, features, and home group.</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/homes","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get home by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-homes/gethomebyid","routeSlug":"/docs/openapi/v1.101.0/modules-homes/gethomebyid","metadata":{"seo":{"title":"Get home by ID","description":"<p>Retrieves complete care home information including ODS code, address, bed capacity, home group, rota settings, and feature flags.</p>"}},"httpPath":"/api/homes/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Incident Reports","link":"/docs/openapi/v1.101.0/modules-incident-reports","routeSlug":"/docs/openapi/v1.101.0/modules-incident-reports","items":[{"label":"Get incident reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-incident-reports/getincidentreports","routeSlug":"/docs/openapi/v1.101.0/modules-incident-reports/getincidentreports","metadata":{"seo":{"title":"Get incident reports","description":"<p>Retrieves incident reports with severity, status, case details, and investigation notes.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>severity</code> - Filter by severity level (1=lowest, 5=highest)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (created_on, closed_on, reviewed_on, or ingested_on)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/incident-reports","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get incident report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-incident-reports/getincidentreportbyid","routeSlug":"/docs/openapi/v1.101.0/modules-incident-reports/getincidentreportbyid","metadata":{"seo":{"title":"Get incident report by ID","description":"<p>Retrieves complete incident details including log, case information, witnesses, actions taken, and closure notes.</p>"}},"httpPath":"/api/incident-reports/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Goals","link":"/docs/openapi/v1.101.0/modules-goals","routeSlug":"/docs/openapi/v1.101.0/modules-goals","items":[{"label":"Get goals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-goals/getgoals","routeSlug":"/docs/openapi/v1.101.0/modules-goals/getgoals","metadata":{"seo":{"title":"Get goals","description":"<p>Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/goals","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get goal by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-goals/getgoalbyid","routeSlug":"/docs/openapi/v1.101.0/modules-goals/getgoalbyid","metadata":{"seo":{"title":"Get goal by ID","description":"<p>Retrieves complete goal details including objectives, progress history, action plans, logs, and success measurements.</p>"}},"httpPath":"/api/goals/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Risk Assessments","link":"/docs/openapi/v1.101.0/modules-risk-assessments","routeSlug":"/docs/openapi/v1.101.0/modules-risk-assessments","items":[{"label":"Get risk assessments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-risk-assessments/getriskassessments","routeSlug":"/docs/openapi/v1.101.0/modules-risk-assessments/getriskassessments","metadata":{"seo":{"title":"Get risk assessments","description":"<p>Retrieves risk assessments with safety evaluations, hazard identification, risk scores, and mitigation strategies.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/risk-assessments","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get risk assessment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-risk-assessments/getriskassessmentbyid","routeSlug":"/docs/openapi/v1.101.0/modules-risk-assessments/getriskassessmentbyid","metadata":{"seo":{"title":"Get risk assessment by ID","description":"<p>Retrieves complete risk assessment details including form data, risk scores, review history, and assessor information.</p>"}},"httpPath":"/api/risk-assessments/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Logs","link":"/docs/openapi/v1.101.0/modules-logs","routeSlug":"/docs/openapi/v1.101.0/modules-logs","items":[{"label":"Get logs (daily care notes)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-logs/getlogs","routeSlug":"/docs/openapi/v1.101.0/modules-logs/getlogs","metadata":{"seo":{"title":"Get logs (daily care notes)","description":"<p>Retrieves logs (daily care notes) logged by staff members about residents' care, activities, and observations.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by log category (e.g., Meals & Nutrition)</li><li><code>itemId</code> - Filter by log category item (e.g., Breakfast)</li><li><code>loggedById</code> - Filter by user who logged the entry</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: timeLogged)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> Deleted logs are automatically excluded from results.</p>"}},"httpPath":"/api/logs","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-logs/getlogbyid","routeSlug":"/docs/openapi/v1.101.0/modules-logs/getlogbyid","metadata":{"seo":{"title":"Get log by ID","description":"<p>Retrieves complete log information including populated references for home, resident, loggedBy, editedBy, category, and item.</p><p>Logs represent daily care notes and observations logged by staff members.</p>"}},"httpPath":"/api/logs/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Categories","link":"/docs/openapi/v1.101.0/modules-log-categories","routeSlug":"/docs/openapi/v1.101.0/modules-log-categories","items":[{"label":"Get log categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-log-categories/getlogcategories","routeSlug":"/docs/openapi/v1.101.0/modules-log-categories/getlogcategories","metadata":{"seo":{"title":"Get log categories","description":"<p>Retrieves log categories used to classify daily care notes and observations.</p><p><strong>Examples:</strong> Meals & Nutrition, Personal Care, Activities, Health & Wellbeing, Medication</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Log categories are public reference data.</p>"}},"httpPath":"/api/logcategories","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log category by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-log-categories/getlogcategorybyid","routeSlug":"/docs/openapi/v1.101.0/modules-log-categories/getlogcategorybyid","metadata":{"seo":{"title":"Get log category by ID","description":"<p>Retrieves a log category with its id, name, and color.</p><p>Log categories are used to organize and classify daily care logs.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategories/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Category Items","link":"/docs/openapi/v1.101.0/modules-log-category-items","routeSlug":"/docs/openapi/v1.101.0/modules-log-category-items","items":[{"label":"Get log category items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-log-category-items/getlogcategoryitems","routeSlug":"/docs/openapi/v1.101.0/modules-log-category-items/getlogcategoryitems","metadata":{"seo":{"title":"Get log category items","description":"<p>Retrieves log category items representing specific activities or observations within a log category.</p><p><strong>Examples:</strong> Breakfast (under Meals & Nutrition), Shower (under Personal Care), Walk in Garden (under Activities)</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Items are sorted by <code>order</code> for proper UI display.</p>"}},"httpPath":"/api/logcategoryitems","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log category item by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-log-category-items/getlogcategoryitembyid","routeSlug":"/docs/openapi/v1.101.0/modules-log-category-items/getlogcategoryitembyid","metadata":{"seo":{"title":"Get log category item by ID","description":"<p>Retrieves a log category item with its id, name, and parent category id.</p><p>Log category items represent specific activities or observations that can be logged by staff members.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategoryitems/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Documents","link":"/docs/openapi/v1.101.0/modules-documents","routeSlug":"/docs/openapi/v1.101.0/modules-documents","items":[{"label":"Get documents (resident documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-documents/getdocuments","routeSlug":"/docs/openapi/v1.101.0/modules-documents/getdocuments","metadata":{"seo":{"title":"Get documents (resident documents)","description":"<p>Retrieves resident-specific documents including medical records, assessments, care plans, and other resident documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/documents","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-documents/getdocumentbyid","routeSlug":"/docs/openapi/v1.101.0/modules-documents/getdocumentbyid","metadata":{"seo":{"title":"Get document by ID","description":"<p>Retrieves complete document information including file details, category, resident, and home references.</p><p>Documents represent files uploaded for specific residents, including PDFs and other file types.</p>"}},"httpPath":"/api/documents/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Home Documents","link":"/docs/openapi/v1.101.0/modules-home-documents","routeSlug":"/docs/openapi/v1.101.0/modules-home-documents","items":[{"label":"Get home documents (home-scoped documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-home-documents/gethomedocuments","routeSlug":"/docs/openapi/v1.101.0/modules-home-documents/gethomedocuments","metadata":{"seo":{"title":"Get home documents (home-scoped documents)","description":"<p>Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>categoryId</code> - Filter by home document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/home-documents","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get home document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-home-documents/gethomedocumentbyid","routeSlug":"/docs/openapi/v1.101.0/modules-home-documents/gethomedocumentbyid","metadata":{"seo":{"title":"Get home document by ID","description":"<p>Retrieves complete home document information including file details, category, and home references.</p><p>Home documents are scoped to care homes rather than individual residents, including policies, procedures, and licenses.</p>"}},"httpPath":"/api/home-documents/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Devices","link":"/docs/openapi/v1.101.0/modules-devices","routeSlug":"/docs/openapi/v1.101.0/modules-devices","items":[{"label":"Get devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-devices/getdevices","routeSlug":"/docs/openapi/v1.101.0/modules-devices/getdevices","metadata":{"seo":{"title":"Get devices","description":"<p>Retrieves devices (tablets, phones, laptops) registered to care homes for logging activities.</p><p>All ObjectId reference fields are populated one level deep with <code>{ id, name }</code>.</p><p>The <code>homes</code> array in the response is filtered to only include entries for homes the API key has access to.</p><p><strong>Filters:</strong></p><ul><li><code>type</code> - Filter by device type (tablet, phone, laptop)</li><li><code>deviceStatus</code> - Filter by home assignment status (pending, approved, blocked)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering on createdOn</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/devices","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get device by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.101.0/modules-devices/getdevicebyid","routeSlug":"/docs/openapi/v1.101.0/modules-devices/getdevicebyid","metadata":{"seo":{"title":"Get device by ID","description":"<p>Retrieves complete device information including populated user references, home assignments with status, and audit fields.</p><p>The <code>homes</code> array is filtered to only include entries for homes the API key has access to. FCM (push notification) fields are excluded from the response.</p>"}},"httpPath":"/api/devices/{id}","version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.101.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"link","label":"Log my Care Open API","link":"/docs/openapi/v1.100.0","routeSlug":"/docs/openapi/v1.100.0"},{"type":"group","label":"health","link":"/docs/openapi/v1.100.0/health","routeSlug":"/docs/openapi/v1.100.0/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/health/gethealth","routeSlug":"/docs/openapi/v1.100.0/health/gethealth","metadata":{"seo":{"title":"Health check","description":"<p>Health check endpoint that returns the application status, uptime, and version information.</p><p>This endpoint is used by load balancers and monitoring systems.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/health"},{"label":"getHealthLegacy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/health/gethealthlegacy","routeSlug":"/docs/openapi/v1.100.0/health/gethealthlegacy","metadata":{"seo":{"title":"getHealthLegacy"}},"httpPath":"/openapi/health"}]},{"type":"group","label":"token-exchange","link":"/docs/openapi/v1.100.0/token-exchange","routeSlug":"/docs/openapi/v1.100.0/token-exchange","items":[{"label":"Exchange API key for short-lived access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/token-exchange/exchangetoken","routeSlug":"/docs/openapi/v1.100.0/token-exchange/exchangetoken","metadata":{"seo":{"title":"Exchange API key for short-lived access token","description":"<p>Exchange a long-lived API key for a short-lived JWT access token (15 minutes).</p><p>This provides enhanced security by minimizing API key exposure.</p>"}},"httpPath":"/auth/token/exchange"}]},{"type":"group","label":"Modules / Residents","link":"/docs/openapi/v1.100.0/modules-residents","routeSlug":"/docs/openapi/v1.100.0/modules-residents","items":[{"label":"Get residents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-residents/getresidents","routeSlug":"/docs/openapi/v1.100.0/modules-residents/getresidents","metadata":{"seo":{"title":"Get residents","description":"<p>Retrieves residents with personal details, medical history, room location, and care preferences.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (e.g., createdOn, admissionDate)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/residents"},{"label":"Create resident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-residents/createresident","routeSlug":"/docs/openapi/v1.100.0/modules-residents/createresident","metadata":{"seo":{"title":"Create resident","description":"Create resident"}},"httpPath":"/api/residents"},{"label":"Get resident by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-residents/getresidentbyid","routeSlug":"/docs/openapi/v1.100.0/modules-residents/getresidentbyid","metadata":{"seo":{"title":"Get resident by ID","description":"<p>Retrieves complete resident information including medical history, allergies, GP details, care preferences, and room location.</p>"}},"httpPath":"/api/residents/{id}"},{"label":"Update resident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-residents/updateresident","routeSlug":"/docs/openapi/v1.100.0/modules-residents/updateresident","metadata":{"seo":{"title":"Update resident","description":"Update resident"}},"httpPath":"/api/residents/{id}"}]},{"type":"group","label":"Modules / Users","link":"/docs/openapi/v1.100.0/modules-users","routeSlug":"/docs/openapi/v1.100.0/modules-users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-users/getusers","routeSlug":"/docs/openapi/v1.100.0/modules-users/getusers","metadata":{"seo":{"title":"Get users","description":"<p>Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/users"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-users/createuser","routeSlug":"/docs/openapi/v1.100.0/modules-users/createuser","metadata":{"seo":{"title":"Create user","description":"Create user"}},"httpPath":"/api/users"},{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-users/getuserbyid","routeSlug":"/docs/openapi/v1.100.0/modules-users/getuserbyid","metadata":{"seo":{"title":"Get user by ID","description":"<p>Retrieves a complete user profile including roles, permissions, homeIds, and employment details. Password fields are excluded for security.</p>"}},"httpPath":"/api/users/{id}"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-users/updateuser","routeSlug":"/docs/openapi/v1.100.0/modules-users/updateuser","metadata":{"seo":{"title":"Update user","description":"Update user"}},"httpPath":"/api/users/{id}"}]},{"type":"group","label":"Modules / Care Plans","link":"/docs/openapi/v1.100.0/modules-care-plans","routeSlug":"/docs/openapi/v1.100.0/modules-care-plans","items":[{"label":"Get care plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-care-plans/getcareplans","routeSlug":"/docs/openapi/v1.100.0/modules-care-plans/getcareplans","metadata":{"seo":{"title":"Get care plans","description":"<p>Retrieves care plans with goals, assessments, documents, and tracking information.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>carePlanId</code> - Filter by care plan ID</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/careplans"},{"label":"Get care plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-care-plans/getcareplanbyid","routeSlug":"/docs/openapi/v1.100.0/modules-care-plans/getcareplanbyid","metadata":{"seo":{"title":"Get care plan by ID","description":"<p>Retrieves a complete care plan including goals, assessments, documents, risk assessments, and review history.</p>"}},"httpPath":"/api/careplans/{id}"}]},{"type":"group","label":"Modules / Homes","link":"/docs/openapi/v1.100.0/modules-homes","routeSlug":"/docs/openapi/v1.100.0/modules-homes","items":[{"label":"Get homes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-homes/gethomes","routeSlug":"/docs/openapi/v1.100.0/modules-homes/gethomes","metadata":{"seo":{"title":"Get homes","description":"<p>Retrieves care homes with facility details, ODS code, address, bed capacity, features, and home group.</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/homes"},{"label":"Get home by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-homes/gethomebyid","routeSlug":"/docs/openapi/v1.100.0/modules-homes/gethomebyid","metadata":{"seo":{"title":"Get home by ID","description":"<p>Retrieves complete care home information including ODS code, address, bed capacity, home group, rota settings, and feature flags.</p>"}},"httpPath":"/api/homes/{id}"}]},{"type":"group","label":"Modules / Incident Reports","link":"/docs/openapi/v1.100.0/modules-incident-reports","routeSlug":"/docs/openapi/v1.100.0/modules-incident-reports","items":[{"label":"Get incident reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-incident-reports/getincidentreports","routeSlug":"/docs/openapi/v1.100.0/modules-incident-reports/getincidentreports","metadata":{"seo":{"title":"Get incident reports","description":"<p>Retrieves incident reports with severity, status, case details, and investigation notes.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>severity</code> - Filter by severity level (1=lowest, 5=highest)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (created_on, closed_on, reviewed_on, or ingested_on)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/incident-reports"},{"label":"Get incident report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-incident-reports/getincidentreportbyid","routeSlug":"/docs/openapi/v1.100.0/modules-incident-reports/getincidentreportbyid","metadata":{"seo":{"title":"Get incident report by ID","description":"<p>Retrieves complete incident details including log, case information, witnesses, actions taken, and closure notes.</p>"}},"httpPath":"/api/incident-reports/{id}"}]},{"type":"group","label":"Modules / Goals","link":"/docs/openapi/v1.100.0/modules-goals","routeSlug":"/docs/openapi/v1.100.0/modules-goals","items":[{"label":"Get goals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-goals/getgoals","routeSlug":"/docs/openapi/v1.100.0/modules-goals/getgoals","metadata":{"seo":{"title":"Get goals","description":"<p>Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/goals"},{"label":"Get goal by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-goals/getgoalbyid","routeSlug":"/docs/openapi/v1.100.0/modules-goals/getgoalbyid","metadata":{"seo":{"title":"Get goal by ID","description":"<p>Retrieves complete goal details including objectives, progress history, action plans, logs, and success measurements.</p>"}},"httpPath":"/api/goals/{id}"}]},{"type":"group","label":"Modules / Risk Assessments","link":"/docs/openapi/v1.100.0/modules-risk-assessments","routeSlug":"/docs/openapi/v1.100.0/modules-risk-assessments","items":[{"label":"Get risk assessments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-risk-assessments/getriskassessments","routeSlug":"/docs/openapi/v1.100.0/modules-risk-assessments/getriskassessments","metadata":{"seo":{"title":"Get risk assessments","description":"<p>Retrieves risk assessments with safety evaluations, hazard identification, risk scores, and mitigation strategies.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/risk-assessments"},{"label":"Get risk assessment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-risk-assessments/getriskassessmentbyid","routeSlug":"/docs/openapi/v1.100.0/modules-risk-assessments/getriskassessmentbyid","metadata":{"seo":{"title":"Get risk assessment by ID","description":"<p>Retrieves complete risk assessment details including form data, risk scores, review history, and assessor information.</p>"}},"httpPath":"/api/risk-assessments/{id}"}]},{"type":"group","label":"Modules / Logs","link":"/docs/openapi/v1.100.0/modules-logs","routeSlug":"/docs/openapi/v1.100.0/modules-logs","items":[{"label":"Get logs (daily care notes)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-logs/getlogs","routeSlug":"/docs/openapi/v1.100.0/modules-logs/getlogs","metadata":{"seo":{"title":"Get logs (daily care notes)","description":"<p>Retrieves logs (daily care notes) logged by staff members about residents' care, activities, and observations.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by log category (e.g., Meals & Nutrition)</li><li><code>itemId</code> - Filter by log category item (e.g., Breakfast)</li><li><code>loggedById</code> - Filter by user who logged the entry</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: timeLogged)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> Deleted logs are automatically excluded from results.</p>"}},"httpPath":"/api/logs"},{"label":"Get log by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-logs/getlogbyid","routeSlug":"/docs/openapi/v1.100.0/modules-logs/getlogbyid","metadata":{"seo":{"title":"Get log by ID","description":"<p>Retrieves complete log information including populated references for home, resident, loggedBy, editedBy, category, and item.</p><p>Logs represent daily care notes and observations logged by staff members.</p>"}},"httpPath":"/api/logs/{id}"}]},{"type":"group","label":"Modules / Log Categories","link":"/docs/openapi/v1.100.0/modules-log-categories","routeSlug":"/docs/openapi/v1.100.0/modules-log-categories","items":[{"label":"Get log categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-log-categories/getlogcategories","routeSlug":"/docs/openapi/v1.100.0/modules-log-categories/getlogcategories","metadata":{"seo":{"title":"Get log categories","description":"<p>Retrieves log categories used to classify daily care notes and observations.</p><p><strong>Examples:</strong> Meals & Nutrition, Personal Care, Activities, Health & Wellbeing, Medication</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Log categories are public reference data.</p>"}},"httpPath":"/api/logcategories"},{"label":"Get log category by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-log-categories/getlogcategorybyid","routeSlug":"/docs/openapi/v1.100.0/modules-log-categories/getlogcategorybyid","metadata":{"seo":{"title":"Get log category by ID","description":"<p>Retrieves a log category with its id, name, and color.</p><p>Log categories are used to organize and classify daily care logs.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategories/{id}"}]},{"type":"group","label":"Modules / Log Category Items","link":"/docs/openapi/v1.100.0/modules-log-category-items","routeSlug":"/docs/openapi/v1.100.0/modules-log-category-items","items":[{"label":"Get log category items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-log-category-items/getlogcategoryitems","routeSlug":"/docs/openapi/v1.100.0/modules-log-category-items/getlogcategoryitems","metadata":{"seo":{"title":"Get log category items","description":"<p>Retrieves log category items representing specific activities or observations within a log category.</p><p><strong>Examples:</strong> Breakfast (under Meals & Nutrition), Shower (under Personal Care), Walk in Garden (under Activities)</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Items are sorted by <code>order</code> for proper UI display.</p>"}},"httpPath":"/api/logcategoryitems"},{"label":"Get log category item by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-log-category-items/getlogcategoryitembyid","routeSlug":"/docs/openapi/v1.100.0/modules-log-category-items/getlogcategoryitembyid","metadata":{"seo":{"title":"Get log category item by ID","description":"<p>Retrieves a log category item with its id, name, and parent category id.</p><p>Log category items represent specific activities or observations that can be logged by staff members.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategoryitems/{id}"}]},{"type":"group","label":"Modules / Documents","link":"/docs/openapi/v1.100.0/modules-documents","routeSlug":"/docs/openapi/v1.100.0/modules-documents","items":[{"label":"Get documents (resident documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-documents/getdocuments","routeSlug":"/docs/openapi/v1.100.0/modules-documents/getdocuments","metadata":{"seo":{"title":"Get documents (resident documents)","description":"<p>Retrieves resident-specific documents including medical records, assessments, care plans, and other resident documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/documents"},{"label":"Get document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-documents/getdocumentbyid","routeSlug":"/docs/openapi/v1.100.0/modules-documents/getdocumentbyid","metadata":{"seo":{"title":"Get document by ID","description":"<p>Retrieves complete document information including file details, category, resident, and home references.</p><p>Documents represent files uploaded for specific residents, including PDFs and other file types.</p>"}},"httpPath":"/api/documents/{id}"}]},{"type":"group","label":"Modules / Home Documents","link":"/docs/openapi/v1.100.0/modules-home-documents","routeSlug":"/docs/openapi/v1.100.0/modules-home-documents","items":[{"label":"Get home documents (home-scoped documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-home-documents/gethomedocuments","routeSlug":"/docs/openapi/v1.100.0/modules-home-documents/gethomedocuments","metadata":{"seo":{"title":"Get home documents (home-scoped documents)","description":"<p>Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>categoryId</code> - Filter by home document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/home-documents"},{"label":"Get home document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-home-documents/gethomedocumentbyid","routeSlug":"/docs/openapi/v1.100.0/modules-home-documents/gethomedocumentbyid","metadata":{"seo":{"title":"Get home document by ID","description":"<p>Retrieves complete home document information including file details, category, and home references.</p><p>Home documents are scoped to care homes rather than individual residents, including policies, procedures, and licenses.</p>"}},"httpPath":"/api/home-documents/{id}"}]},{"type":"group","label":"Modules / Devices","link":"/docs/openapi/v1.100.0/modules-devices","routeSlug":"/docs/openapi/v1.100.0/modules-devices","items":[{"label":"Get devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-devices/getdevices","routeSlug":"/docs/openapi/v1.100.0/modules-devices/getdevices","metadata":{"seo":{"title":"Get devices","description":"<p>Retrieves devices (tablets, phones, laptops) registered to care homes for logging activities.</p><p>All ObjectId reference fields are populated one level deep with <code>{ id, name }</code>.</p><p>The <code>homes</code> array in the response is filtered to only include entries for homes the API key has access to.</p><p><strong>Filters:</strong></p><ul><li><code>type</code> - Filter by device type (tablet, phone, laptop)</li><li><code>deviceStatus</code> - Filter by home assignment status (pending, approved, blocked)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering on createdOn</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/devices"},{"label":"Get device by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.100.0/modules-devices/getdevicebyid","routeSlug":"/docs/openapi/v1.100.0/modules-devices/getdevicebyid","metadata":{"seo":{"title":"Get device by ID","description":"<p>Retrieves complete device information including populated user references, home assignments with status, and audit fields.</p><p>The <code>homes</code> array is filtered to only include entries for homes the API key has access to. FCM (push notification) fields are excluded from the response.</p>"}},"httpPath":"/api/devices/{id}"}]},{"type":"link","label":"Log my Care Open API","link":"/docs/openapi/v1.97.0","routeSlug":"/docs/openapi/v1.97.0","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"health","link":"/docs/openapi/v1.97.0/health","routeSlug":"/docs/openapi/v1.97.0/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/health/gethealth","routeSlug":"/docs/openapi/v1.97.0/health/gethealth","metadata":{"seo":{"title":"Health check","description":"<p>Health check endpoint that returns the application status, uptime, and version information.</p><p>This endpoint is used by load balancers and monitoring systems.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/health","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"getHealthLegacy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/health/gethealthlegacy","routeSlug":"/docs/openapi/v1.97.0/health/gethealthlegacy","metadata":{"seo":{"title":"getHealthLegacy"}},"httpPath":"/openapi/health","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"token-exchange","link":"/docs/openapi/v1.97.0/token-exchange","routeSlug":"/docs/openapi/v1.97.0/token-exchange","items":[{"label":"Exchange API key for short-lived access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/token-exchange/exchangetoken","routeSlug":"/docs/openapi/v1.97.0/token-exchange/exchangetoken","metadata":{"seo":{"title":"Exchange API key for short-lived access token","description":"<p>Exchange a long-lived API key for a short-lived JWT access token (15 minutes).</p><p>This provides enhanced security by minimizing API key exposure.</p>"}},"httpPath":"/auth/token/exchange","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Residents","link":"/docs/openapi/v1.97.0/modules-residents","routeSlug":"/docs/openapi/v1.97.0/modules-residents","items":[{"label":"Get residents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-residents/getresidents","routeSlug":"/docs/openapi/v1.97.0/modules-residents/getresidents","metadata":{"seo":{"title":"Get residents","description":"<p>Retrieves residents with personal details, medical history, room location, and care preferences.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (e.g., createdOn, admissionDate)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/residents","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Create resident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-residents/createresident","routeSlug":"/docs/openapi/v1.97.0/modules-residents/createresident","metadata":{"seo":{"title":"Create resident","description":"Create resident"}},"httpPath":"/api/residents","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get resident by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-residents/getresidentbyid","routeSlug":"/docs/openapi/v1.97.0/modules-residents/getresidentbyid","metadata":{"seo":{"title":"Get resident by ID","description":"<p>Retrieves complete resident information including medical history, allergies, GP details, care preferences, and room location.</p>"}},"httpPath":"/api/residents/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Update resident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-residents/updateresident","routeSlug":"/docs/openapi/v1.97.0/modules-residents/updateresident","metadata":{"seo":{"title":"Update resident","description":"Update resident"}},"httpPath":"/api/residents/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Users","link":"/docs/openapi/v1.97.0/modules-users","routeSlug":"/docs/openapi/v1.97.0/modules-users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-users/getusers","routeSlug":"/docs/openapi/v1.97.0/modules-users/getusers","metadata":{"seo":{"title":"Get users","description":"<p>Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/users","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-users/createuser","routeSlug":"/docs/openapi/v1.97.0/modules-users/createuser","metadata":{"seo":{"title":"Create user","description":"Create user"}},"httpPath":"/api/users","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-users/getuserbyid","routeSlug":"/docs/openapi/v1.97.0/modules-users/getuserbyid","metadata":{"seo":{"title":"Get user by ID","description":"<p>Retrieves a complete user profile including roles, permissions, homeIds, and employment details. Password fields are excluded for security.</p>"}},"httpPath":"/api/users/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-users/updateuser","routeSlug":"/docs/openapi/v1.97.0/modules-users/updateuser","metadata":{"seo":{"title":"Update user","description":"Update user"}},"httpPath":"/api/users/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Care Plans","link":"/docs/openapi/v1.97.0/modules-care-plans","routeSlug":"/docs/openapi/v1.97.0/modules-care-plans","items":[{"label":"Get care plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-care-plans/getcareplans","routeSlug":"/docs/openapi/v1.97.0/modules-care-plans/getcareplans","metadata":{"seo":{"title":"Get care plans","description":"<p>Retrieves care plans with goals, assessments, documents, and tracking information.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>carePlanId</code> - Filter by care plan ID</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/careplans","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get care plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-care-plans/getcareplanbyid","routeSlug":"/docs/openapi/v1.97.0/modules-care-plans/getcareplanbyid","metadata":{"seo":{"title":"Get care plan by ID","description":"<p>Retrieves a complete care plan including goals, assessments, documents, risk assessments, and review history.</p>"}},"httpPath":"/api/careplans/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Homes","link":"/docs/openapi/v1.97.0/modules-homes","routeSlug":"/docs/openapi/v1.97.0/modules-homes","items":[{"label":"Get homes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-homes/gethomes","routeSlug":"/docs/openapi/v1.97.0/modules-homes/gethomes","metadata":{"seo":{"title":"Get homes","description":"<p>Retrieves care homes with facility details, CQC registration, address, capacity, and regulator information.</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/homes","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get home by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-homes/gethomebyid","routeSlug":"/docs/openapi/v1.97.0/modules-homes/gethomebyid","metadata":{"seo":{"title":"Get home by ID","description":"<p>Retrieves complete care home information including CQC registration, address, bed capacity, home group, and regulator details.</p>"}},"httpPath":"/api/homes/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Incident Reports","link":"/docs/openapi/v1.97.0/modules-incident-reports","routeSlug":"/docs/openapi/v1.97.0/modules-incident-reports","items":[{"label":"Get incident reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-incident-reports/getincidentreports","routeSlug":"/docs/openapi/v1.97.0/modules-incident-reports/getincidentreports","metadata":{"seo":{"title":"Get incident reports","description":"<p>Retrieves incident reports with severity, status, case details, and investigation notes.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>severity</code> - Filter by severity level (1=lowest, 5=highest)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (created_on, closed_on, reviewed_on, or ingested_on)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/incident-reports","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get incident report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-incident-reports/getincidentreportbyid","routeSlug":"/docs/openapi/v1.97.0/modules-incident-reports/getincidentreportbyid","metadata":{"seo":{"title":"Get incident report by ID","description":"<p>Retrieves complete incident details including log, case information, witnesses, actions taken, and closure notes.</p>"}},"httpPath":"/api/incident-reports/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Goals","link":"/docs/openapi/v1.97.0/modules-goals","routeSlug":"/docs/openapi/v1.97.0/modules-goals","items":[{"label":"Get goals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-goals/getgoals","routeSlug":"/docs/openapi/v1.97.0/modules-goals/getgoals","metadata":{"seo":{"title":"Get goals","description":"<p>Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/goals","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get goal by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-goals/getgoalbyid","routeSlug":"/docs/openapi/v1.97.0/modules-goals/getgoalbyid","metadata":{"seo":{"title":"Get goal by ID","description":"<p>Retrieves complete goal details including objectives, progress history, action plans, logs, and success measurements.</p>"}},"httpPath":"/api/goals/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Risk Assessments","link":"/docs/openapi/v1.97.0/modules-risk-assessments","routeSlug":"/docs/openapi/v1.97.0/modules-risk-assessments","items":[{"label":"Get risk assessments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-risk-assessments/getriskassessments","routeSlug":"/docs/openapi/v1.97.0/modules-risk-assessments/getriskassessments","metadata":{"seo":{"title":"Get risk assessments","description":"<p>Retrieves risk assessments with safety evaluations, hazard identification, risk scores, and mitigation strategies.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/risk-assessments","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get risk assessment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-risk-assessments/getriskassessmentbyid","routeSlug":"/docs/openapi/v1.97.0/modules-risk-assessments/getriskassessmentbyid","metadata":{"seo":{"title":"Get risk assessment by ID","description":"<p>Retrieves complete risk assessment details including form data, risk scores, review history, and assessor information.</p>"}},"httpPath":"/api/risk-assessments/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Logs","link":"/docs/openapi/v1.97.0/modules-logs","routeSlug":"/docs/openapi/v1.97.0/modules-logs","items":[{"label":"Get logs (daily care notes)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-logs/getlogs","routeSlug":"/docs/openapi/v1.97.0/modules-logs/getlogs","metadata":{"seo":{"title":"Get logs (daily care notes)","description":"<p>Retrieves logs (daily care notes) logged by staff members about residents' care, activities, and observations.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by log category (e.g., Meals & Nutrition)</li><li><code>itemId</code> - Filter by log category item (e.g., Breakfast)</li><li><code>loggedById</code> - Filter by user who logged the entry</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: timeLogged)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> Deleted logs are automatically excluded from results.</p>"}},"httpPath":"/api/logs","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-logs/getlogbyid","routeSlug":"/docs/openapi/v1.97.0/modules-logs/getlogbyid","metadata":{"seo":{"title":"Get log by ID","description":"<p>Retrieves complete log information including populated references for home, resident, loggedBy, editedBy, category, and item.</p><p>Logs represent daily care notes and observations logged by staff members.</p>"}},"httpPath":"/api/logs/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Categories","link":"/docs/openapi/v1.97.0/modules-log-categories","routeSlug":"/docs/openapi/v1.97.0/modules-log-categories","items":[{"label":"Get log categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-log-categories/getlogcategories","routeSlug":"/docs/openapi/v1.97.0/modules-log-categories/getlogcategories","metadata":{"seo":{"title":"Get log categories","description":"<p>Retrieves log categories used to classify daily care notes and observations.</p><p><strong>Examples:</strong> Meals & Nutrition, Personal Care, Activities, Health & Wellbeing, Medication</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Log categories are public reference data.</p>"}},"httpPath":"/api/logcategories","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log category by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-log-categories/getlogcategorybyid","routeSlug":"/docs/openapi/v1.97.0/modules-log-categories/getlogcategorybyid","metadata":{"seo":{"title":"Get log category by ID","description":"<p>Retrieves complete log category information including name, color, itemId, and custom/global status.</p><p>Log categories are used to organize and classify daily care logs.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategories/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Category Items","link":"/docs/openapi/v1.97.0/modules-log-category-items","routeSlug":"/docs/openapi/v1.97.0/modules-log-category-items","items":[{"label":"Get log category items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-log-category-items/getlogcategoryitems","routeSlug":"/docs/openapi/v1.97.0/modules-log-category-items/getlogcategoryitems","metadata":{"seo":{"title":"Get log category items","description":"<p>Retrieves log category items representing specific activities or observations within a log category.</p><p><strong>Examples:</strong> Breakfast (under Meals & Nutrition), Shower (under Personal Care), Walk in Garden (under Activities)</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Items are sorted by <code>order</code> for proper UI display.</p>"}},"httpPath":"/api/logcategoryitems","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get log category item by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-log-category-items/getlogcategoryitembyid","routeSlug":"/docs/openapi/v1.97.0/modules-log-category-items/getlogcategoryitembyid","metadata":{"seo":{"title":"Get log category item by ID","description":"<p>Retrieves complete log category item information including name, category reference, order, and visibility settings.</p><p>Log category items represent specific activities or observations that can be logged by staff members.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategoryitems/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Documents","link":"/docs/openapi/v1.97.0/modules-documents","routeSlug":"/docs/openapi/v1.97.0/modules-documents","items":[{"label":"Get documents (resident documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-documents/getdocuments","routeSlug":"/docs/openapi/v1.97.0/modules-documents/getdocuments","metadata":{"seo":{"title":"Get documents (resident documents)","description":"<p>Retrieves resident-specific documents including medical records, assessments, care plans, and other resident documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/documents","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-documents/getdocumentbyid","routeSlug":"/docs/openapi/v1.97.0/modules-documents/getdocumentbyid","metadata":{"seo":{"title":"Get document by ID","description":"<p>Retrieves complete document information including file details, category, resident, and home references.</p><p>Documents represent files uploaded for specific residents, including PDFs and other file types.</p>"}},"httpPath":"/api/documents/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Home Documents","link":"/docs/openapi/v1.97.0/modules-home-documents","routeSlug":"/docs/openapi/v1.97.0/modules-home-documents","items":[{"label":"Get home documents (home-scoped documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-home-documents/gethomedocuments","routeSlug":"/docs/openapi/v1.97.0/modules-home-documents/gethomedocuments","metadata":{"seo":{"title":"Get home documents (home-scoped documents)","description":"<p>Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>categoryId</code> - Filter by home document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/home-documents","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get home document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-home-documents/gethomedocumentbyid","routeSlug":"/docs/openapi/v1.97.0/modules-home-documents/gethomedocumentbyid","metadata":{"seo":{"title":"Get home document by ID","description":"<p>Retrieves complete home document information including file details, category, and home references.</p><p>Home documents are scoped to care homes rather than individual residents, including policies, procedures, and licenses.</p>"}},"httpPath":"/api/home-documents/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Devices","link":"/docs/openapi/v1.97.0/modules-devices","routeSlug":"/docs/openapi/v1.97.0/modules-devices","items":[{"label":"Get devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-devices/getdevices","routeSlug":"/docs/openapi/v1.97.0/modules-devices/getdevices","metadata":{"seo":{"title":"Get devices","description":"<p>Retrieves devices (tablets, phones, laptops) registered to care homes for logging activities.</p><p>All ObjectId reference fields are populated one level deep with <code>{ id, name }</code>.</p><p>The <code>homes</code> array in the response is filtered to only include entries for homes the API key has access to.</p><p><strong>Filters:</strong></p><ul><li><code>type</code> - Filter by device type (tablet, phone, laptop)</li><li><code>deviceStatus</code> - Filter by home assignment status (pending, approved, blocked)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering on createdOn</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/devices","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"label":"Get device by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/v1.97.0/modules-devices/getdevicebyid","routeSlug":"/docs/openapi/v1.97.0/modules-devices/getdevicebyid","metadata":{"seo":{"title":"Get device by ID","description":"<p>Retrieves complete device information including populated user references, home assignments with status, and audit fields.</p><p>The <code>homes</code> array is filtered to only include entries for homes the API key has access to. FCM (push notification) fields are excluded from the response.</p>"}},"httpPath":"/api/devices/{id}","version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"}],"version":"v1.97.0","isDefault":false,"versionFolderId":"83d03932"},{"type":"link","label":"Log my Care Open API","link":"/docs/openapi","routeSlug":"/docs/openapi","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"health","link":"/docs/openapi/health","routeSlug":"/docs/openapi/health","items":[{"label":"Health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/health/gethealth","routeSlug":"/docs/openapi/health/gethealth","metadata":{"seo":{"title":"Health check","description":"<p>Health check endpoint that returns the application status, uptime, and version information.</p><p>This endpoint is used by load balancers and monitoring systems.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/health","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"getHealthLegacy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/health/gethealthlegacy","routeSlug":"/docs/openapi/health/gethealthlegacy","metadata":{"seo":{"title":"getHealthLegacy"}},"httpPath":"/openapi/health","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"token-exchange","link":"/docs/openapi/token-exchange","routeSlug":"/docs/openapi/token-exchange","items":[{"label":"Exchange API key for short-lived access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/token-exchange/exchangetoken","routeSlug":"/docs/openapi/token-exchange/exchangetoken","metadata":{"seo":{"title":"Exchange API key for short-lived access token","description":"<p>Exchange a long-lived API key for a short-lived JWT access token (15 minutes).</p><p>This provides enhanced security by minimizing API key exposure.</p>"}},"httpPath":"/auth/token/exchange","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Residents","link":"/docs/openapi/modules-residents","routeSlug":"/docs/openapi/modules-residents","items":[{"label":"Get residents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-residents/getresidents","routeSlug":"/docs/openapi/modules-residents/getresidents","metadata":{"seo":{"title":"Get residents","description":"<p>Retrieves residents with personal details, medical history, room location, and care preferences.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (e.g., createdOn, admissionDate)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/residents","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Create resident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-residents/createresident","routeSlug":"/docs/openapi/modules-residents/createresident","metadata":{"seo":{"title":"Create resident","description":"Create resident"}},"httpPath":"/api/residents","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get resident by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-residents/getresidentbyid","routeSlug":"/docs/openapi/modules-residents/getresidentbyid","metadata":{"seo":{"title":"Get resident by ID","description":"<p>Retrieves complete resident information including medical history, allergies, GP details, care preferences, and room location.</p>"}},"httpPath":"/api/residents/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Update resident","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-residents/updateresident","routeSlug":"/docs/openapi/modules-residents/updateresident","metadata":{"seo":{"title":"Update resident","description":"Update resident"}},"httpPath":"/api/residents/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Users","link":"/docs/openapi/modules-users","routeSlug":"/docs/openapi/modules-users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-users/getusers","routeSlug":"/docs/openapi/modules-users/getusers","metadata":{"seo":{"title":"Get users","description":"<p>Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/users","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Create user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-users/createuser","routeSlug":"/docs/openapi/modules-users/createuser","metadata":{"seo":{"title":"Create user","description":"Create user"}},"httpPath":"/api/users","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-users/getuserbyid","routeSlug":"/docs/openapi/modules-users/getuserbyid","metadata":{"seo":{"title":"Get user by ID","description":"<p>Retrieves a complete user profile including roles, permissions, homeIds, and employment details. Password fields are excluded for security.</p>"}},"httpPath":"/api/users/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-users/updateuser","routeSlug":"/docs/openapi/modules-users/updateuser","metadata":{"seo":{"title":"Update user","description":"Update user"}},"httpPath":"/api/users/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Care Plans","link":"/docs/openapi/modules-care-plans","routeSlug":"/docs/openapi/modules-care-plans","items":[{"label":"Get care plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-care-plans/getcareplans","routeSlug":"/docs/openapi/modules-care-plans/getcareplans","metadata":{"seo":{"title":"Get care plans","description":"<p>Retrieves care plans with goals, assessments, documents, and tracking information.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>carePlanId</code> - Filter by care plan ID</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdOn)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/careplans","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get care plan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-care-plans/getcareplanbyid","routeSlug":"/docs/openapi/modules-care-plans/getcareplanbyid","metadata":{"seo":{"title":"Get care plan by ID","description":"<p>Retrieves a complete care plan including goals, assessments, documents, risk assessments, and review history.</p>"}},"httpPath":"/api/careplans/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Homes","link":"/docs/openapi/modules-homes","routeSlug":"/docs/openapi/modules-homes","items":[{"label":"Get homes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-homes/gethomes","routeSlug":"/docs/openapi/modules-homes/gethomes","metadata":{"seo":{"title":"Get homes","description":"<p>Retrieves care homes with facility details, ODS code, address, bed capacity, features, and home group.</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/homes","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get home by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-homes/gethomebyid","routeSlug":"/docs/openapi/modules-homes/gethomebyid","metadata":{"seo":{"title":"Get home by ID","description":"<p>Retrieves complete care home information including ODS code, address, bed capacity, home group, rota settings, and feature flags.</p>"}},"httpPath":"/api/homes/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Incident Reports","link":"/docs/openapi/modules-incident-reports","routeSlug":"/docs/openapi/modules-incident-reports","items":[{"label":"Get incident reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-incident-reports/getincidentreports","routeSlug":"/docs/openapi/modules-incident-reports/getincidentreports","metadata":{"seo":{"title":"Get incident reports","description":"<p>Retrieves incident reports with severity, status, case details, and investigation notes.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>severity</code> - Filter by severity level (1=lowest, 5=highest)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (created_on, closed_on, reviewed_on, or ingested_on)</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/incident-reports","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get incident report by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-incident-reports/getincidentreportbyid","routeSlug":"/docs/openapi/modules-incident-reports/getincidentreportbyid","metadata":{"seo":{"title":"Get incident report by ID","description":"<p>Retrieves complete incident details including log, case information, witnesses, actions taken, and closure notes.</p>"}},"httpPath":"/api/incident-reports/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Goals","link":"/docs/openapi/modules-goals","routeSlug":"/docs/openapi/modules-goals","items":[{"label":"Get goals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-goals/getgoals","routeSlug":"/docs/openapi/modules-goals/getgoals","metadata":{"seo":{"title":"Get goals","description":"<p>Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/goals","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get goal by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-goals/getgoalbyid","routeSlug":"/docs/openapi/modules-goals/getgoalbyid","metadata":{"seo":{"title":"Get goal by ID","description":"<p>Retrieves complete goal details including objectives, progress history, action plans, logs, and success measurements.</p>"}},"httpPath":"/api/goals/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Risk Assessments","link":"/docs/openapi/modules-risk-assessments","routeSlug":"/docs/openapi/modules-risk-assessments","items":[{"label":"Get risk assessments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-risk-assessments/getriskassessments","routeSlug":"/docs/openapi/modules-risk-assessments/getriskassessments","metadata":{"seo":{"title":"Get risk assessments","description":"<p>Retrieves risk assessments with safety evaluations, hazard identification, risk scores, and mitigation strategies.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>page</code>, <code>limit</code> - Pagination controls</li></ul>"}},"httpPath":"/api/risk-assessments","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get risk assessment by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-risk-assessments/getriskassessmentbyid","routeSlug":"/docs/openapi/modules-risk-assessments/getriskassessmentbyid","metadata":{"seo":{"title":"Get risk assessment by ID","description":"<p>Retrieves complete risk assessment details including form data, risk scores, review history, and assessor information.</p>"}},"httpPath":"/api/risk-assessments/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Logs","link":"/docs/openapi/modules-logs","routeSlug":"/docs/openapi/modules-logs","items":[{"label":"Get logs (daily care notes)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-logs/getlogs","routeSlug":"/docs/openapi/modules-logs/getlogs","metadata":{"seo":{"title":"Get logs (daily care notes)","description":"<p>Retrieves logs (daily care notes) logged by staff members about residents' care, activities, and observations.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by log category (e.g., Meals & Nutrition)</li><li><code>itemId</code> - Filter by log category item (e.g., Breakfast)</li><li><code>loggedById</code> - Filter by user who logged the entry</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: timeLogged)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> Deleted logs are automatically excluded from results.</p>"}},"httpPath":"/api/logs","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get log by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-logs/getlogbyid","routeSlug":"/docs/openapi/modules-logs/getlogbyid","metadata":{"seo":{"title":"Get log by ID","description":"<p>Retrieves complete log information including populated references for home, resident, loggedBy, editedBy, category, and item.</p><p>Logs represent daily care notes and observations logged by staff members.</p>"}},"httpPath":"/api/logs/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Categories","link":"/docs/openapi/modules-log-categories","routeSlug":"/docs/openapi/modules-log-categories","items":[{"label":"Get log categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-log-categories/getlogcategories","routeSlug":"/docs/openapi/modules-log-categories/getlogcategories","metadata":{"seo":{"title":"Get log categories","description":"<p>Retrieves log categories used to classify daily care notes and observations.</p><p><strong>Examples:</strong> Meals & Nutrition, Personal Care, Activities, Health & Wellbeing, Medication</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Log categories are public reference data.</p>"}},"httpPath":"/api/logcategories","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get log category by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-log-categories/getlogcategorybyid","routeSlug":"/docs/openapi/modules-log-categories/getlogcategorybyid","metadata":{"seo":{"title":"Get log category by ID","description":"<p>Retrieves a log category with its id, name, and color.</p><p>Log categories are used to organize and classify daily care logs.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategories/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Log Category Items","link":"/docs/openapi/modules-log-category-items","routeSlug":"/docs/openapi/modules-log-category-items","items":[{"label":"Get log category items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-log-category-items/getlogcategoryitems","routeSlug":"/docs/openapi/modules-log-category-items/getlogcategoryitems","metadata":{"seo":{"title":"Get log category items","description":"<p>Retrieves log category items representing specific activities or observations within a log category.</p><p><strong>Examples:</strong> Breakfast (under Meals & Nutrition), Shower (under Personal Care), Walk in Garden (under Activities)</p><p><strong>Filters:</strong></p><ul><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul><p><strong>Note:</strong> This endpoint does not require authentication. Items are sorted by <code>order</code> for proper UI display.</p>"}},"httpPath":"/api/logcategoryitems","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get log category item by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-log-category-items/getlogcategoryitembyid","routeSlug":"/docs/openapi/modules-log-category-items/getlogcategoryitembyid","metadata":{"seo":{"title":"Get log category item by ID","description":"<p>Retrieves a log category item with its id, name, and parent category id.</p><p>Log category items represent specific activities or observations that can be logged by staff members.</p><p><strong>Note:</strong> This endpoint does not require authentication.</p>"}},"httpPath":"/api/logcategoryitems/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Documents","link":"/docs/openapi/modules-documents","routeSlug":"/docs/openapi/modules-documents","items":[{"label":"Get documents (resident documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-documents/getdocuments","routeSlug":"/docs/openapi/modules-documents/getdocuments","metadata":{"seo":{"title":"Get documents (resident documents)","description":"<p>Retrieves resident-specific documents including medical records, assessments, care plans, and other resident documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>residentId</code> - Filter by specific resident</li><li><code>categoryId</code> - Filter by document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/documents","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-documents/getdocumentbyid","routeSlug":"/docs/openapi/modules-documents/getdocumentbyid","metadata":{"seo":{"title":"Get document by ID","description":"<p>Retrieves complete document information including file details, category, resident, and home references.</p><p>Documents represent files uploaded for specific residents, including PDFs and other file types.</p>"}},"httpPath":"/api/documents/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Home Documents","link":"/docs/openapi/modules-home-documents","routeSlug":"/docs/openapi/modules-home-documents","items":[{"label":"Get home documents (home-scoped documents)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-home-documents/gethomedocuments","routeSlug":"/docs/openapi/modules-home-documents/gethomedocuments","metadata":{"seo":{"title":"Get home documents (home-scoped documents)","description":"<p>Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.</p><p><strong>Filters:</strong></p><ul><li><code>homeId</code> - Filter by specific care home</li><li><code>categoryId</code> - Filter by home document category</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering</li><li><code>dateField</code> - Date field to filter on (default: createdAt)</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/home-documents","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get home document by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-home-documents/gethomedocumentbyid","routeSlug":"/docs/openapi/modules-home-documents/gethomedocumentbyid","metadata":{"seo":{"title":"Get home document by ID","description":"<p>Retrieves complete home document information including file details, category, and home references.</p><p>Home documents are scoped to care homes rather than individual residents, including policies, procedures, and licenses.</p>"}},"httpPath":"/api/home-documents/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"type":"group","label":"Modules / Devices","link":"/docs/openapi/modules-devices","routeSlug":"/docs/openapi/modules-devices","items":[{"label":"Get devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-devices/getdevices","routeSlug":"/docs/openapi/modules-devices/getdevices","metadata":{"seo":{"title":"Get devices","description":"<p>Retrieves devices (tablets, phones, laptops) registered to care homes for logging activities.</p><p>All ObjectId reference fields are populated one level deep with <code>{ id, name }</code>.</p><p>The <code>homes</code> array in the response is filtered to only include entries for homes the API key has access to.</p><p><strong>Filters:</strong></p><ul><li><code>type</code> - Filter by device type (tablet, phone, laptop)</li><li><code>deviceStatus</code> - Filter by home assignment status (pending, approved, blocked)</li><li><code>startDate</code>, <code>endDate</code> - Date range filtering on createdOn</li><li><code>page</code>, <code>limit</code> - Pagination controls (default: page=1, limit=10, max=100)</li></ul>"}},"httpPath":"/api/devices","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"},{"label":"Get device by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/modules-devices/getdevicebyid","routeSlug":"/docs/openapi/modules-devices/getdevicebyid","metadata":{"seo":{"title":"Get device by ID","description":"<p>Retrieves complete device information including populated user references, home assignments with status, and audit fields.</p><p>The <code>homes</code> array is filtered to only include entries for homes the API key has access to. FCM (push notification) fields are excluded from the response.</p>"}},"httpPath":"/api/devices/{id}","version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}],"version":"v1.108.0","isDefault":true,"versionFolderId":"83d03932"}]}