CarePredict started as an idea from our founder Satish Movva who wanted to provide better care for his aging parents while ensuring peace of mind. Since 2013, CarePredict has evolved into a movement to transform the senior care industry, enabling proactive health interventions based on behavioral patterns.
\nOur technology leverages AI-driven insights to predict health declines in seniors, empowering caregivers across assisted living, memory care, independent living communities, and home care settings.
\nThe CarePredict Integration API is a RESTful API designed for seamless integration with third-party applications and external partners. It enables partners to:
\nRetrieve facility, resident, and staff data
\nAccess AI-driven risk analytics and social interaction metrics
\nSubmit device events from wireless nurse call systems and IoT hardware
\nAuthenticate securely using a two-legged server-to-server flow
\nAll API responses are JSON-encoded and follow standard HTTP response codes.
\n\n\nOnce granted credentials, all API users will have access to a sandbox environment to interact with realistic data before going live.
\n
All requests use the {{api_gateway_url}} variable as the base URL. Set this variable in your active environment.
Example base URL:
\nhttps://api-gateway.carepredict.com\n\nCarePredict uses a two-legged authentication approach for server-to-server integration.
\nSend a POST request to the authenticate endpoint with your credentials and CP-Client-Secret-Key header:
POST {{api_gateway_url}}/auth/user/authenticate\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\nContent-Type: application/json\n{\n \"username\": \"your_username\",\n \"password\": \"your_password\"\n}\n\nA successful response returns a JWT bearer token:
\n{\n \"status\": \"OK\",\n \"message\": \"Token generated successfully\",\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzUxMiJ9...\",\n \"expiresInSec\": 1800\n },\n \"code\": 200,\n \"timestamp\": \"2026-02-25T18:25:16.145Z\"\n}\n\n\n\nTokens expire after 1800 seconds (30 minutes). Re-authenticate before expiry to maintain uninterrupted access.
\n
All Partner API requests use the bearer token via the Authorization header. This collection is pre-configured to use {{vault:auth_token}} at the collection level — store your token there.
Authorization: Bearer {{vault:auth_token}}\n\nThe Device Ingest endpoints use a different authentication mechanism — a CP-Client-Secret-Key header instead of a bearer token:
CP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\n\n\n\nSecurity Note: Vault variables are encrypted and never exposed in plain text. Never store secrets in environment variables — always use Postman Vault for sensitive values.
\n
The CarePredict API enforces rate limiting on all endpoints. Rate limit details are returned in response headers:
\nBest Practice: Monitor X-RateLimit-Remaining in your integration. If it approaches 0, implement exponential backoff before retrying.
All API responses follow a consistent envelope structure:
\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2026-02-25T18:25:16.145Z\",\n \"data\": { ... },\n \"message\": \"Human-readable result message\"\n}\n\nError Response Example:
\n{\n \"code\": 401,\n \"status\": \"Unauthorized\",\n \"timestamp\": \"2025-04-14T22:05:41.873Z\",\n \"error\": {\n \"message\": \"Unauthorized: Invalid client secret key or 'CP-Client-Secret-Key' header is missing\"\n }\n}\n\nCarePredict takes data privacy and security seriously. All API consumers must adhere to the following:
\nMuch of the data accessible via the CarePredict API is considered Protected Health Information (PHI) under HIPAA.
\nAll API access is secured via SSL/TLS.
\nData stored by CarePredict is Encrypted-At-Rest.
\nAn account must be created by the CarePredict support team before any user can access the API.
\nAny organization wishing to access the API must sign a Business Associate Agreement (BAA) with CarePredict prior to gaining access.
\nAccess to specific data types is granted on a client-by-client basis based on integration requirements.
\n# Step 1: Authenticate\nPOST {{api_gateway_url}}/auth/user/authenticate\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\nContent-Type: application/json\n{\"username\": \"{{username}}\", \"password\": \"your_password\"}\n# Step 2: Copy the token from the response and store it in vault:auth_token\n# Step 3: Fetch all residents for a facility\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/resident/all\nAuthorization: Bearer {{vault:auth_token}}\n\nPOST {{api_gateway_url}}/external-device/v1/integration/{{vault:integration-partner-name}}/facilities/{{vault:facilityId}}/device-events\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\nContent-Type: application/json\n{\n \"uniqueHardwareId\": \"DEVICE-001\",\n \"hardwareType\": \"pull_cord\",\n \"hardwareLocation\": \"Room 212\",\n \"eventType\": \"start\"\n}\n\nThe CarePredict APIs are actively maintained by the CarePredict Software Development Team.
\n📧 Contact us at support@carepredict.com to:
\nRequest API access and credentials
\nSign the Business Associate Agreement
\nGet sandbox environment access
\nReport issues or request new features
\nSubmits a device-triggered event from an external integration partner's hardware to the CarePredict platform. This endpoint is part of the CarePredict External Device Integration API and enables wireless nurse call systems and other partner devices to push real-time events into CarePredict.
\nThis endpoint allows external device vendors to report events such as fall detections, pull cord activations, and other hardware-triggered alerts directly to CarePredict. The platform processes these events and associates them with the appropriate facility and resident context for care team response.
\nPOST {{api_gateway_url}}/external-device/v1/integration/{{vault:integration-partner-name}}/facilities/{{vault:facilityId}}/device-events\n\nThis endpoint uses a client secret key for partner identification. No bearer token is required.
\nThe request body must be sent as raw JSON.
\n{\n \"eventId\": \"34e437a0-1c7b-41d8-a9c7-48d0873b90ff\",\n \"uniqueHardwareId\": \"AFUSK94BA3FBF2120623\",\n \"hardwareType\": \"Camera\",\n \"hardwareLocation\": \"R44A ROOM\",\n \"eventTime\": \"2025-10-29T03:24:08Z\",\n \"eventType\": \"FALL_DETECTED\",\n \"imageURL\": \"https://example.com/image.jpg\",\n \"videoURL\": \"https://example.com/video.mp4\"\n}\n\n200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-29T03:24:08.000Z\",\n \"message\": \"Device event received successfully\"\n}\n\n401 UnauthorizedReturned when the CP-Client-Secret-Key header is missing or invalid.
{\n \"code\": 401,\n \"status\": \"Unauthorized\",\n \"message\": \"Invalid or missing CP-Client-Secret-Key\"\n}\n\n400 Bad RequestReturned when required fields are missing from the request body.
\n{\n \"code\": 400,\n \"status\": \"Bad Request\",\n \"message\": \"Missing required field: hardwareType\"\n}\n\n\n\nNote: All required body fields must be present. Omitting any required field will result in a
\n400 Bad Requestresponse.
POST {{api_gateway_url}}/external-device/v1/integration/{{vault:integration-partner-name}}/facilities/{{vault:facilityId}}/device-events\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\nContent-Type: application/json\n{\n \"eventId\": \"34e437a0-1c7b-41d8-a9c7-48d0873b90ff\",\n \"uniqueHardwareId\": \"AFUSK94BA3FBF2120623\",\n \"hardwareType\": \"Camera\",\n \"hardwareLocation\": \"R44A ROOM\",\n \"eventTime\": \"2025-10-29T03:24:08Z\",\n \"eventType\": \"FALL_DETECTED\",\n \"imageURL\": \"https://example.com/image.jpg\",\n \"videoURL\": \"https://example.com/video.mp4\"\n}\n\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-29T03:24:08.000Z\",\n \"message\": \"Device event received successfully\"\n}\n\nThese APIs are designed for partners offering wireless nurse call systems, enabling their device-triggered events to integrate seamlessly with CarePredict.
\nAll requests in this folder use a partner secret key passed via the CP-Client-Secret-Key request header. Refer to your CarePredict integration contact to obtain your credentials.
This folder contains APIs and integration endpoints for third-party device vendors that partner with CarePredict. It serves as the top-level grouping for all vendor-facing integrations, enabling external hardware and software providers to connect their devices and systems with the CarePredict platform.
\nThe Device Vendors folder organizes endpoints that allow external partners to push device-generated data and events into CarePredict's ecosystem. These integrations are critical for extending CarePredict's monitoring and care intelligence capabilities through partner hardware.
\nAuthenticates an integration partner user and returns a bearer token for use in subsequent API calls. This endpoint is part of the CarePredict Integration API and is the entry point for all partner authentication flows.
\nThis endpoint validates the provided credentials and returns a short-lived JWT bearer token. The token must be stored and passed as the Authorization header in all subsequent requests. Integration partners should re-authenticate when the token expires (default: 1800 seconds / 30 minutes).
POST {{api_gateway_url}}/auth/user/authenticate\n\nThis endpoint does not require a bearer token. Instead, it requires the CP-Client-Secret-Key header to identify the integration partner.
The request body must be sent as raw JSON.
\n{\n \"username\": \"Your username\",\n \"password\": \"Your password\"\n}\n\n200 OK{\n \"status\": \"OK\",\n \"message\": \"User authenticated successfully\",\n \"data\": {\n \"token\": \"<JWT bearer token>\",\n \"expiresInSec\": 1800\n },\n \"code\": 200,\n \"timestamp\": \"2025-02-05T23:14:24.556Z\"\n}\n\n404 Not Found{\n \"status\": \"Not Found\",\n \"error\": {\n \"message\": \"User not found for username: <username>\"\n }\n}\n\n\n\nNote: Store the returned
\ntokensecurely (e.g., in the Postman Vault asvault:auth_token) and use it as theAuthorization: Bearer {{token}}header in all subsequent requests.
POST {{api_gateway_url}}/auth/user/authenticate\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\nContent-Type: application/json\n{\n \"username\": \"Your username\",\n \"password\": \"Your password\"\n}\n\n{\n \"status\": \"OK\",\n \"message\": \"User authenticated successfully\",\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expiresInSec\": 1800\n },\n \"code\": 200,\n \"timestamp\": \"2025-02-05T23:14:24.556Z\"\n}\n\nRetrieves the permissions and facility access rights associated with a specific integration partner user. This endpoint is part of the CarePredict Integration API and is used to determine which facilities and institutions a user is authorized to access.
\nThis endpoint returns the list of facilityId and institutionId values that the authenticated user has access to. Integration partners can use this data to validate access scope before making facility-specific API calls.
GET {{api_gateway_url}}/auth/user/{{username}}/permissions\nThis endpoint requires the CP-Client-Secret-Key header to identify the integration partner.
200 OK{\n \"status\": \"OK\",\n \"message\": \"Successfully retrieved user permissions\",\n \"data\": {\n \"username\": \"cp_developer\",\n \"facilityId\": [1324434, 1373244],\n \"institutionId\": [113342341]\n },\n \"code\": 200,\n \"timestamp\": \"2025-02-05T23:14:24.556Z\"\n}\n\n\nNote: Use the
\nfacilityIdvalues returned here as the{{facilityId}}variable in subsequent facility-scoped API calls.
GET {{api_gateway_url}}/auth/user/{{username}}/permissions\nCP-Client-Secret-Key: {{vault:CP-Client-Secret-Key}}\n{\n \"status\": \"OK\",\n \"message\": \"Successfully retrieved user permissions\",\n \"data\": {\n \"username\": \"cp_developer\",\n \"facilityId\": [1324434, 1373244],\n \"institutionId\": [113342341]\n },\n \"code\": 200,\n \"timestamp\": \"2025-02-05T23:14:24.556Z\"\n}\nThis collection consists of APIs related to Authentication
\nNOTE: The client secret key must be stored securely
\nGet an access token by sending a POST request to CarePredict system more details are provided in AuthenticateUser request in this collection along with client secret key
For all API requests, attach the value of access token as an authorization header of type Bearer
\n","_postman_id":"e2507ba0-adf6-4ff5-888a-d6b4c66b996a"},{"name":"Facility","item":[{"name":"Facility Details By ID","id":"c90dc6a8-fbd3-4ee5-810d-13facfb60f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/integration/facility/{{facilityId}}","description":"Retrieves the details of a specific facility by its unique identifier. This endpoint is part of the CarePredict Integration API and is designed to surface facility profile information for integration partners.
\nThis endpoint returns key metadata about a CarePredict facility, including its name, address, timezone, and subdomain. Integration partners can use this data to display facility information or validate facility configuration before making resident or staff data requests.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"id\": 0,\n \"facility\": {\n \"facilityID\": 112345,\n \"name\": \"Facility Name\",\n \"address\": \"123 Main St\",\n \"city\": \"City\",\n \"state\": \"State\",\n \"country\": \"Country\",\n \"timezone\": \"America/New_York\",\n \"subDomain\": \"subdomain\"\n }\n },\n \"message\": \"Facility details retrieved successfully\"\n}\ndata.facility)401 Unauthorized{\n \"error\": {\n \"message\": \"Access to given resource is forbidden\"\n }\n}\n\n\nNote: Ensure the bearer token is valid and has not expired. Re-authenticate using the AuthenticateUser endpoint if a
\n401is returned.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}\nAuthorization: Bearer {{vault:auth_token}}\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"data\": {\n \"id\": 0,\n \"facility\": {\n \"facilityID\": 112345,\n \"name\": \"Sunrise Senior Living\",\n \"address\": \"456 Elm Street\",\n \"city\": \"Orlando\",\n \"state\": \"FL\",\n \"country\": \"US\",\n \"timezone\": \"America/New_York\",\n \"subDomain\": \"sunrise\"\n }\n },\n \"message\": \"Facility details retrieved successfully\"\n}\nThis Collection consists of APIs related to Facility Details
\n","_postman_id":"a2db2650-666d-4433-b610-90cd1a7fffa8"},{"name":"Staff","item":[{"name":"Staff Details","id":"f01f3f62-7210-436f-a23c-599a3557d1ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/integration/facility/{{facilityId}}/staff/all","description":"Retrieves the details of all staff members associated with a specific facility. This endpoint is part of the CarePredict Integration API and is designed to surface complete staff roster data for care teams and integration partners.
\nThis endpoint supports bulk staff data retrieval by returning demographic profile information for every staff member within a facility. Integration partners can use this data to synchronize CarePredict staff records with external systems and maintain an up-to-date roster across platforms.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/staff/all\n\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-02-08T05:47:03.865Z\",\n \"data\": {\n \"staff\": [ ... ]\n },\n \"message\": \"Staff details fetched successfully\"\n}\n\ndata.staff)Each entry in the staff array contains the following fields:
\n\nNote: The
\nstaffarray will contain one object per staff member currently associated with the facility. If no staff members are found for the givenfacilityId, the array may be empty.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}/staff/all\nAuthorization: Bearer {{token}}\n\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-02-08T05:47:03.865Z\",\n \"data\": {\n \"staff\": [\n {\n \"residentID\": 1223456,\n \"firstName\": \"Staff First Name\",\n \"lastName\": \"Staff Last Name\",\n \"gender\": \"GENDER\"\n },\n {\n \"residentID\": 123457,\n \"firstName\": \"Staff First Name\",\n \"lastName\": \"Staff Last Name\",\n \"gender\": \"GENDER\"\n }\n ]\n },\n \"message\": \"Staff details fetched successfully\"\n}\n\nThis Collection consists of APIs related to Staff Details in a facility
\n","_postman_id":"ae93624c-924b-4a2b-9612-7d0a6e91a400"},{"name":"Resident","item":[{"name":"Resident Details","id":"9e09b33d-3a2b-46e8-958c-c60364795135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/integration/facility/{{facilityId}}/resident/all","description":"Retrieves the details of all residents associated with a specific facility. This endpoint is part of the CarePredict Integration API and is designed to surface complete resident roster data for care teams and integration partners.
\nThis endpoint supports bulk resident data retrieval by returning demographic and EHR-linked profile information for every resident within a facility. Integration partners can use this data to synchronize CarePredict resident records with external EHR systems and maintain an up-to-date roster across platforms.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/resident/all\n\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-21T19:55:45.697Z\",\n \"data\": {\n \"ehrName\": \"ALIS\",\n \"residents\": [ ... ]\n },\n \"message\": \"Residents fetched successfully\"\n}\n\ndata.residents)Each entry in the residents array contains the following fields:
\n\nNote: The
\nresidentsarray will contain one object per resident currently associated with the facility. If no residents are found for the givenfacilityId, the array may be empty.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}/resident/all\nAuthorization: Bearer {{token}}\n\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-21T19:55:45.697Z\",\n \"data\": {\n \"ehrName\": \"ALIS\",\n \"residents\": [\n {\n \"externalResidentId\": 1123,\n \"residentID\": 46083,\n \"firstName\": \"Rob\",\n \"lastName\": \"McMac\",\n \"gender\": \"MALE\",\n \"dateOfBirth\": \"1952-05-08\"\n },\n {\n \"externalResidentId\": 23145,\n \"residentID\": 65549,\n \"firstName\": \"Ethan\",\n \"lastName\": \"Hawk\",\n \"gender\": \"MALE\",\n \"dateOfBirth\": \"1955-03-01\"\n }\n ]\n },\n \"message\": \"Residents fetched successfully\"\n}\n\nRetrieves the details of a specific resident within a facility using their unique resident identifier. This endpoint is part of the CarePredict Integration API and is designed to surface individual resident profile data for care teams and integration partners.
\nThis endpoint supports targeted resident data retrieval by returning demographic and EHR-linked profile information for a single resident. Integration partners can use this data to look up a specific resident's record and synchronize it with external EHR systems.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/resident/{{resident_id}}\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-21T19:55:45.697Z\",\n \"data\": {\n \"ehrName\": \"ALIS\",\n \"residents\": [ ... ]\n },\n \"message\": \"Residents fetched successfully\"\n}\ndata.residents)\n\nNote: Even though this endpoint targets a single resident, the response wraps the result in a
\nresidentsarray for consistency with the bulk endpoint.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}/resident/{{resident_id}}\nAuthorization: Bearer {{vault:auth_token}}\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-10-21T19:55:45.697Z\",\n \"data\": {\n \"ehrName\": \"ALIS\",\n \"residents\": [\n {\n \"externalResidentId\": 2981,\n \"residentID\": 46896,\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"gender\": \"FEMALE\",\n \"dateOfBirth\": \"1948-07-14\"\n }\n ]\n },\n \"message\": \"Residents fetched successfully\"\n}\nThis Collection consists of APIs related to Resident Details in a facility
\n","_postman_id":"59fec3ad-8ee4-4eea-854c-c25fbc15df67"},{"name":"Risk & Analytics","item":[{"name":"Resident Risk Flags (ADL)","id":"bf5ae91e-53ee-4bba-b1f6-1a652f750c22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/v1/integration/facilities/{{facilityId}}/risk-flag?currentDateTime=2026-02-25T13:27:00&days=3","description":"Retrieves risk flag profiles for all residents in a facility as of a specified date and time. This endpoint is part of the CarePredict Integration API and surfaces AI-generated risk assessments across multiple health domains.
\nThis endpoint returns residents who have been flagged for elevated risk across four key health categories: Depression, Fall, Nutrition, and UTI. Integration partners and care teams can use this data to proactively identify at-risk residents and coordinate timely interventions.
\nGET {{api_gateway_url}}/v1/integration/facilities/{{vault:facilityId}}/risk-flag\nThis endpoint requires a valid bearer token passed via the Authorization header.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2026-02-25T13:27:00.000Z\",\n \"data\": {\n \"riskProfiles\": {\n \"Depression Risk\": [ ... ],\n \"Fall Risk\": [ ... ],\n \"Nutrition Risk\": [ ... ],\n \"UTI Risk\": [ ... ]\n }\n },\n \"message\": \"Risk flags fetched successfully\"\n}\ndata.riskProfiles)\n\nNote: A resident may appear in multiple risk categories simultaneously. If no residents are flagged for a given category, the array will be empty.
\n
GET {{api_gateway_url}}/v1/integration/facilities/{{vault:facilityId}}/risk-flag?currentDateTime=2026-02-25T13:27:00&days=3\nAuthorization: Bearer {{token}}\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2026-02-25T13:27:00.000Z\",\n \"data\": {\n \"riskProfiles\": {\n \"Depression Risk\": [\n { \"residentID\": 46083, \"firstName\": \"Rob\", \"lastName\": \"McMac\", \"suiteNumber\": \"101A\" }\n ],\n \"Fall Risk\": [\n { \"residentID\": 65549, \"firstName\": \"Ethan\", \"lastName\": \"Hawk\", \"suiteNumber\": \"204B\" }\n ],\n \"Nutrition Risk\": [],\n \"UTI Risk\": [\n { \"residentID\": 46896, \"firstName\": \"Jane\", \"lastName\": \"Doe\", \"suiteNumber\": \"312C\" }\n ]\n }\n },\n \"message\": \"Risk flags fetched successfully\"\n}\noptional, range = [1,7]
\n","type":"text/plain"},"key":"days","value":"3"}],"variable":[]}},"response":[{"id":"4e1019b1-3f1a-4763-a6ad-0cc9ce9a37d8","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_gateway_url}}/v1/integration/facilities/{{vault:facilityId}}/risk-flag?currentDateTime=2026-02-25T13:27:00&days=3","host":["{{api_gateway_url}}"],"path":["v1","integration","facilities","{{vault:facilityId}}","risk-flag"],"query":[{"key":"currentDateTime","value":"2026-02-25T13:27:00"},{"key":"days","value":"3","description":"optional, range = [1,7]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Wed, 25 Feb 2026 18:28:37 GMT","enabled":true},{"key":"Content-Type","value":"application/json;charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-RateLimit-Remaining","value":"19","enabled":true},{"key":"X-RateLimit-Requested-Tokens","value":"1","enabled":true},{"key":"X-RateLimit-Burst-Capacity","value":"20","enabled":true},{"key":"X-RateLimit-Replenish-Rate","value":"10","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS, DELETE, PATCH","enabled":true},{"key":"Access-Control-Max-Age","value":"36000","enabled":true},{"key":"Access-Control-Allow-Headers","value":"x-auth-token, Content-Type, X-WC-Webhook-Signature, Authorization, apikey, auth","enabled":true},{"key":"Access-Control-Expose-Headers","value":"x-auth-token, Content-Type","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Expires","value":"0","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains","enabled":true}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2026-02-25T18:28:37.699Z\",\n \"data\": {\n \"riskProfiles\": {\n \"Depression Risk\": [\n {\n \"residentID\":1234,\n \"firstName\": \"John\",\n \"lastName\": \"Wick\",\n \"suiteNumber\": \"818\"\n },\n // other residents details\n ],\n \"Fall Risk\": [\n {\n \"residentID\": 1235,\n \"firstName\": \"Baba\",\n \"lastName\": \"Yaga\",\n \"suiteNumber\": \"818\"\n },\n // other residents details\n ],\n \"Nutrition Risk\": [\n {\n \"residentID\": 1236,\n \"firstName\": \"Winston\",\n \"lastName\": \"Scott\",\n \"suiteNumber\": \"Lobby\"\n },\n // other residents details\n ],\n \"UTI Risk\": [\n {\n \"residentID\": 1237,\n \"firstName\": \"Bowery\",\n \"lastName\": \"King\",\n \"suiteNumber\": \"A13\"\n },\n // other residents details\n ]\n }\n },\n \"message\": \"Risk flag status fetched successfully\"\n}"}],"_postman_id":"bf5ae91e-53ee-4bba-b1f6-1a652f750c22"},{"name":"Social Interaction Data","id":"6c255918-f05c-406c-8111-9ab58732391c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/integration/facility/{{facilityId}}/social-interaction/residents/all?startDateTime=2024-11-04T00%3A00%3A00Z&endDateTime=2025-01-05T00%3A00%3A00Z","description":"Retrieves social interaction statistics for all residents in a facility over a specified date range. This endpoint is part of the CarePredict Integration API and surfaces engagement and interaction metrics tracked by the CarePredict platform.
\nThis endpoint returns daily social interaction data for every resident in a facility, including wearable usage, interaction counts, unique people encountered, and total interaction time. Integration partners and care teams can use this data to monitor resident engagement trends and identify residents who may be socially isolated.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/social-interaction/residents/all\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-01-05T00:00:00.000Z\",\n \"data\": [ ... ],\n \"message\": \"Social interaction data fetched successfully\"\n}\ndata)socialInteractionStats)\n\nNote: The
\ndataarray will contain one object per resident. If no interaction data is available for a resident within the specified date range, theirsocialInteractionStatsarray may be empty.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}/social-interaction/residents/all?startDateTime=2024-11-04T00:00:00Z&endDateTime=2025-01-05T00:00:00Z\nAuthorization: Bearer {{vault:auth_token}}\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-01-05T00:00:00.000Z\",\n \"data\": [\n {\n \"residentId\": 46083,\n \"socialInteractionStats\": [\n {\n \"date\": \"2024-11-04\",\n \"totalPercentWorn\": 82.5,\n \"interactionCount\": 14,\n \"uniquePeopleCount\": 6,\n \"interactionMinutes\": 47.3\n }\n ]\n }\n ],\n \"message\": \"Social interaction data fetched successfully\"\n}\nRetrieves social interaction statistics for a specific resident in a facility over a specified date range. This endpoint is part of the CarePredict Integration API and surfaces engagement and interaction metrics tracked by the CarePredict platform for an individual resident.
\nThis endpoint returns daily social interaction data for a single resident, including wearable usage, interaction counts, unique people encountered, and total interaction time. Integration partners and care teams can use this data to monitor an individual resident's engagement trends and identify signs of social isolation.
\nGET {{api_gateway_url}}/integration/facility/{{facilityId}}/social-interaction/residents/{{vault:residentId}}\nThis endpoint requires a valid bearer token passed via the Authorization header. The token is stored securely in the Postman Vault.
200 OK{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-01-05T00:00:00.000Z\",\n \"data\": {\n \"residentId\": 64186,\n \"socialInteractionStats\": [ ... ]\n },\n \"message\": \"Social interaction data fetched successfully\"\n}\ndata.socialInteractionStats)\n\nNote: If no interaction data is available for the resident within the specified date range, the
\nsocialInteractionStatsarray will be empty.
GET {{api_gateway_url}}/integration/facility/{{facilityId}}/social-interaction/residents/{{vault:residentId}}?startDateTime=2024-11-04T00:00:00Z&endDateTime=2025-01-05T00:00:00Z\nAuthorization: Bearer {{vault:auth_token}}\n{\n \"code\": 200,\n \"status\": \"OK\",\n \"timestamp\": \"2025-01-05T00:00:00.000Z\",\n \"data\": {\n \"residentId\": 64186,\n \"socialInteractionStats\": [\n {\n \"date\": \"2024-11-04\",\n \"totalPercentWorn\": 76.0,\n \"interactionCount\": 9,\n \"uniquePeopleCount\": 4,\n \"interactionMinutes\": 31.5\n }\n ]\n },\n \"message\": \"Social interaction data fetched successfully\"\n}\nRetrieves the sentiment scores for all staff members associated with a specific facility. This endpoint is part of the CarePredict Integration API and is used to surface staff satisfaction and engagement metrics, enabling facility administrators and integration partners to monitor workforce sentiment trends over time.
\nThis endpoint returns a list of staff members along with their computed sentiment scores for the given facility. Sentiment scores are derived from CarePredict's internal analytics engine and reflect staff engagement levels on a scale from 0 to 5. Higher scores indicate more positive sentiment.
\nAll requests must include a valid JWT bearer token in the Authorization header.
Authorization: Bearer {{vault:jwt-staging}}\n\nThe token must be associated with a user who has access to the specified facility.
\nA successful request returns HTTP 200 OK with a JSON body containing a data array of staff sentiment records.
Response Fields
\nExample Response
\n{\n \"status\": \"OK\",\n \"message\": \"Staff sentiment score fetched successfully\",\n \"data\": [\n { \"staffId\": 38085, \"sentimentScore\": 4 },\n { \"staffId\": 38092, \"sentimentScore\": 4.96 },\n { \"staffId\": 59699, \"sentimentScore\": 4.71 },\n { \"staffId\": 60958, \"sentimentScore\": 5 },\n { \"staffId\": 65486, \"sentimentScore\": 2.83 },\n { \"staffId\": 38079, \"sentimentScore\": 4.99 },\n { \"staffId\": 45077, \"sentimentScore\": 4.08 },\n { \"staffId\": 61216, \"sentimentScore\": 4.76 },\n { \"staffId\": 63958, \"sentimentScore\": 5 },\n { \"staffId\": 38062, \"sentimentScore\": 4.29 }\n ],\n \"code\": 200,\n \"timestamp\": \"2026-03-24T20:20:42.58360303Z\"\n}\n\nSentiment scores are floating-point values on a scale of 0 to 5, where 5 represents the highest positive sentiment.
Only staff members belonging to the specified facility are included in the response.
\nThe facilityId path variable is resolved from the vault at runtime using {{vault:facilityId}}.
This endpoint is read-only (GET) and does not modify any data.
Ensure the JWT token has not expired and is scoped to the correct facility before making the request.
\nAnalytics endpoints for risk flags and resident social-interaction insights for a facility.
\nRequires a valid access token.
\nAuthorization: Bearer {{token}} (or your team’s configured token variable)Authorization: Bearer
Accept: application/json
{{api_gateway_url}}
{{facilityId}}
{{residentId}} (for resident-specific endpoints)
Some requests accept date/time window filters:
\nstartDateTime (ISO 8601, e.g. 2024-11-15T00:00:00Z)
endDateTime (ISO 8601, e.g. 2024-12-01T00:00:00Z)
Resident Risk Flags (ADL)
\nSocial Interaction For All Residents
\nSocial Interaction By Resident Id
\nStaff Sentiment Score
\nRetrieves all resident-initiated alerts for a specific facility within a given date/time range. Use this endpoint to query alerts that were triggered directly by residents during the specified period.
\nThis endpoint requires a Bearer token passed via the Authorization header.
Authorization: Bearer {{jwt}}\n\nEnsure the jwt variable is set in your active environment before sending the request.
Both parameters must be provided as ISO 8601 datetime strings without timezone offset.
\nOn success, the endpoint returns a list of resident-initiated alerts recorded for the specified facility within the given date/time range.
\n","urlObject":{"path":["api","v1","facilities","{{facilityId}}","resident-initiated-alerts"],"host":["{{api_gateway_url}}"],"query":[{"key":"startDateTime","value":"2026-02-01T22:13:10"},{"key":"endDateTime","value":"2026-03-10T22:13:10"}],"variable":[]}},"response":[{"id":"ea075080-ed97-4ea7-8097-f2f17521e57b","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_gateway_url}}/api/v1/facilities/{{facilityId}}/resident-initiated-alerts?startDateTime=2026-03-16T15:00:00&endDateTime=2026-03-16T15:30:10","host":["{{api_gateway_url}}"],"path":["api","v1","facilities","{{facilityId}}","resident-initiated-alerts"],"query":[{"key":"startDateTime","value":"2026-03-16T15:00:00"},{"key":"endDateTime","value":"2026-03-16T15:30:10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"date","value":"Mon, 16 Mar 2026 21:57:29 GMT"},{"key":"content-type","value":"application/json"},{"key":"x-ratelimit-remaining","value":"19"},{"key":"x-ratelimit-requested-tokens","value":"1"},{"key":"x-ratelimit-burst-capacity","value":"20"},{"key":"x-ratelimit-replenish-rate","value":"10"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-xss-protection","value":"0"},{"key":"cache-control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"x-frame-options","value":"DENY"},{"key":"x-envoy-upstream-service-time","value":"21"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"message\": \"Resident initiated alerts fetched successfully\",\n \"data\": [\n {\n \"alertList\": [\n {\n \"id\": 173594,\n \"type\": \"button_press\",\n \"startTime\": \"2026-03-16T15:27:00\",\n \"endTime\": \"2026-03-16T15:28:06\",\n \"ackTime\": \"2026-03-16T15:27:46\",\n \"staffId\": 78737,\n \"status\": \"completed\"\n }\n ],\n \"residentId\": 55219\n },\n {\n \"alertList\": [\n {\n \"id\": 173591,\n \"type\": \"button_press\",\n \"startTime\": \"2026-03-16T15:22:27\",\n \"endTime\": \"2026-03-16T15:31:30\",\n \"ackTime\": \"2026-03-16T15:28:30\",\n \"staffId\": 78358,\n \"status\": \"completed\"\n }\n ],\n \"residentId\": 75842\n },\n {\n \"alertList\": [\n {\n \"id\": 173593,\n \"type\": \"button_press\",\n \"startTime\": \"2026-03-16T15:25:55\",\n \"endTime\": \"2026-03-16T17:00:06\",\n \"ackTime\": \"2026-03-16T16:58:18\",\n \"staffId\": 67827,\n \"status\": \"completed\"\n }\n ],\n \"residentId\": 80685\n },\n {\n \"alertList\": [\n {\n \"id\": 173588,\n \"type\": \"button_press\",\n \"startTime\": \"2026-03-16T15:11:11\",\n \"endTime\": \"2026-03-16T15:16:32\",\n \"ackTime\": \"2026-03-16T15:16:19\",\n \"staffId\": 78737,\n \"status\": \"completed\"\n },\n {\n \"id\": 173592,\n \"type\": \"button_press\",\n \"startTime\": \"2026-03-16T15:25:08\",\n \"endTime\": \"2026-03-16T15:27:01\",\n \"ackTime\": \"2026-03-16T15:25:51\",\n \"staffId\": 78358,\n \"status\": \"completed\"\n }\n ],\n \"residentId\": 68332\n }\n ],\n \"code\": 200,\n \"timestamp\": \"2026-03-16T21:57:29.183947067Z\"\n}"}],"_postman_id":"f0500f15-a189-4f0c-bd2f-fc32a6ff8528"},{"name":"Fall Alert","id":"395711b3-be5f-468e-b370-b03cde54b894","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwt}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{api_gateway_url}}/api/v1/facilities/{{facilityId}}/fall-alerts?startDateTime=2026-02-01T22:13:10&endDateTime=2026-03-10T22:13:10","description":"Retrieves all fall alerts for residents within a specified facility over a given date range. Results are grouped by resident, with each entry containing a list of fall alert events and their associated metadata (severity, type, acknowledgement info, etc.).
\nThis endpoint requires a Bearer token passed via the Authorization header.
Authorization: Bearer {{jwt}}\n\nReturns a list of fall alerts grouped by resident.
\n{\n \"status\": \"OK\",\n \"message\": \"Fall alerts fetched successfully\",\n \"code\": 200,\n \"timestamp\": \"2026-03-16T21:43:20.676998302Z\",\n \"data\": [\n {\n \"residentId\": 69472,\n \"alertList\": [\n {\n \"id\": 162516,\n \"startTime\": \"2026-02-10T10:48:44\",\n \"endTime\": \"2026-02-10T10:56:46\",\n \"ackTime\": \"2026-02-10T10:56:01\",\n \"staffId\": 55122,\n \"status\": \"completed\",\n \"fallSeverity\": \"Low (Resident fine after fall)\",\n \"fallType\": \"Resident Confirmed Fall\"\n }\n ]\n }\n ]\n}\n\ndata[] ObjectalertList[] ObjectThis folder contains endpoints for retrieving event-based alerts associated with residents within a facility. It covers two categories of alerts:
\nFall Alerts — System-recorded alerts for fall incidents involving residents, grouped by resident with metadata such as severity, fall type, and acknowledgement details.
\nResident Initiated Alerts — Alerts triggered directly by residents within a facility during a specified time period.
\nPartner-facing endpoints for retrieving CarePredict facility, resident, staff, and analytics data.
\nMost requests in this section require an access token obtained from the Authentication folder.
\nAuthorization: Bearer {{token}} (or your team’s configured token variable)Authorization: Bearer
Content-Type: application/json (for POST/PUT; not required for GET)
Common variables referenced by requests in this section:
\n{{api_gateway_url}} (base URL)
{{facilityId}}
{{resident_id}}
Folder: Authentication (token generation)
\nFolder: Facility, Resident, Staff, Risk & Analytics
\n