{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"18a63330-0610-4828-b80d-9627612f9412","name":"CareLynx API","description":"## **📘 Overview**\n\nCareLynx provides a comprehensive set of RESTful endpoints to access both **clinical** and **non-clinical** data of care recipients. We currently offer **21 endpoints**, with new endpoints continuously added to simplify and improve third-party integrations.\n\nThis documentation includes:\n\n- Detailed overview of each endpoint\n    \n- Real-world usage examples\n    \n- Schema for request and response payloads\n    \n\n### **Developer-Friendly Features**\n\n- Select your preferred **programming language** from the dropdown to view code samples.\n    \n- Switch between **Light** and **Dark** mode using the toggle at the top right for your comfort.\n    \n\n---\n\n## **✅ Prerequisites**\n\nBefore you begin, ensure the following:\n\n### **🔧 Tools**\n\n- **Postman Collection**: Click the `Run in Postman` button located in the top right corner of this page\n    \n- **Swagger UI**: [Swagger UI](https://dev.api.carelynxapp.com/api/v2/docs)\n    \n\nHelpful Resources:\n\n- [Postman Docs](https://learning.postman.com/docs/introduction/overview/)\n    \n- [Swagger UI Docs](https://swagger.io/tools/swagger-ui/)\n    \n\n### **🔐 Authentication**\n\nCareLynx API uses **OAuth 2.0** for secure authentication.\n\nLearn more: [OAuth 2.0 Overview](https://www.oauth.com/)\n\n### **🛠 Required Configuration**\n\nYou’ll need the following config variables to use the API:\n\n- CLIENT_ID\n    \n- CLIENT_SECRET\n    \n- API_KEY\n    \n- SCOPE\n    \n- BASE_URL\n    \n- AUTH_URL\n    \n\n> ⚠️ **NOTE** \n  \n> Every API request must include an `x-api-key` header containing your API_KEY value. This is required to authenticate and authorize access to all endpoints. \n  \n\nIf you need access to these values or face issues, email us at\n\n📧 [support@carelynx.com](https://mailto:support@carelynx.com).\n\n#### 🔧 **Postman Authorization Setup Sample**\n\n<img src=\"https://content.pstmn.io/55c0ee78-0119-4d9f-94be-0de14e30661f/U2NyZWVuc2hvdCAyMDI1LTA1LTI2IGF0IDEwLjUwLjEw4oCvYW0ucG5n\">\n\n#### 🔧 **Postman Header Setup Sample**\n\n<img src=\"https://content.pstmn.io/c8580490-f277-434f-8923-e9f87c60713a/U2NyZWVuc2hvdCAyMDI1LTA1LTI2IGF0IDEwLjUxLjMw4oCvYW0ucG5n\">\n\n---\n\n## **📂 Available Endpoints**\n\n- GET /api/v2/careRecipients\n    \n    → Fetch a list of all care recipients\n    \n\nAll the following endpoints are scoped to a specific care recipient via :careRecipientId.\n\n---\n\n#### **Personal & Administrative Details**\n\n- GET /api/v2/careRecipients/:careRecipientId/peopleResponsible\n    \n- GET /api/v2/careRecipients/:careRecipientId/medicalOfficerDetails\n    \n- GET /api/v2/careRecipients/:careRecipientId/medicareAndInsuranceDetails\n    \n- GET /api/v2/careRecipients/:careRecipientId/pensionAndBenefitsDetails\n    \n- GET /api/v2/careRecipients/:careRecipientId/personalDetails\n    \n- GET /api/v2/careRecipients/:careRecipientId/contacts\n    \n\n---\n\n#### **Clinical Records**\n\n- GET /api/v2/careRecipients/:careRecipientId/allergies\n    \n- GET /api/v2/careRecipients/:careRecipientId/observations\n    \n- GET /api/v2/careRecipients/:careRecipientId/bowelObservations\n    \n- GET /api/v2/careRecipients/:careRecipientId/wounds\n    \n- GET /api/v2/careRecipients/:careRecipientId/infectionControl\n    \n- GET /api/v2/careRecipients/:careRecipientId/behaviours\n    \n- GET /api/v2/careRecipients/:careRecipientId/technicalNursingRequirements\n    \n- GET /api/v2/careRecipients/:careRecipientId/rugAdls\n    \n- GET /api/v2/careRecipients/:careRecipientId/akps\n    \n- GET /api/v2/careRecipients/:careRecipientId/palliativeCares\n    \n- GET /api/v2/careRecipients/:careRecipientId/frailties\n    \n- GET /api/v2/careRecipients/:careRecipientId/accidentsAndIncidents\n    \n\n---\n\n#### **Allied Health**\n\n- GET /api/v2/careRecipients/:careRecipientId/alliedHealthDetails\n    \n- GET /api/v2/careRecipients/:careRecipientId/alliedHealthReferralVisits\n    \n\n---\n\n## **⚠️ HTTP Status Codes**\n\n| **Code** | **Meaning** |\n| --- | --- |\n| 200 | ✅ Success |\n| 400 | ❌ Bad Request – Missing parameter (e.g., page, careRecipientId) |\n| 401 | 🔒 Unauthorized – Invalid CLIENT_ID, CLIENT_SECRET, or SCOPE |\n| 403 | ⛔ Forbidden – Invalid or expired API_KEY |\n| 404 | 🔎 Not Found – Invalid careRecipientId |\n| 500 | 💥 Server Error – Something went wrong on our end. Please send your request payload or curl to support for investigation. |\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41091850","team":6639630,"collectionId":"18a63330-0610-4828-b80d-9627612f9412","publishedId":"2sB2qcCgRe","public":true,"publicUrl":"https://openapi.carelynxapp.com","privateUrl":"https://go.postman.co/documentation/41091850-18a63330-0610-4828-b80d-9627612f9412","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"279989"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/1af65e6a-9d1d-4184-9f3c-301b3510fd6f/Q2FyZUx5bnggTG9nbyBTdGFja2VkLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"279989"}},{"name":"light","logo":"https://content.pstmn.io/1af65e6a-9d1d-4184-9f3c-301b3510fd6f/Q2FyZUx5bnggTG9nbyBTdGFja2VkLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"279989"}}]}},"version":"8.10.1","publishDate":"2025-10-14T06:45:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/1af65e6a-9d1d-4184-9f3c-301b3510fd6f/Q2FyZUx5bnggTG9nbyBTdGFja2VkLnBuZw==","logoDark":"https://content.pstmn.io/1af65e6a-9d1d-4184-9f3c-301b3510fd6f/Q2FyZUx5bnggTG9nbyBTdGFja2VkLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7c363017ba3f36b2411a9c09795dad5fb1a3f0de57415baddc572d63d27f5502","favicon":"https://carelynxapp.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://openapi.carelynxapp.com/view/metadata/2sB2qcCgRe"}