Jump to Content
Guides
API
Changelog
v3.0
v3.1
v3.2
Log In
API
Log In
v3.2
Guides
API
Changelog
Update Note
JUMP TO
Medocity Platform API
File Upload
Upload file
post
Upload multiple files
post
Upload file for a specific user
post
Upload multiple files for a specific user
post
Get Authorised File Access
get
Get Contact Information of User
get
Update Contact Information of a user
patch
Dashboard
Get User Dashboards
get
Create Dashboard
post
Get Client Dashboards
get
Get Client Dashboards by Column
get
Copy a system dashboard to a client
post
Get Dashboard By Id
get
Modify Dashboard
patch
Delete Dashboard
del
Create Widget
post
Get Widgets
get
Get Widget By Id
get
Update Widget
patch
Delete Widget
del
Calendar
Get Client Calendar Settings
get
Update Client Calendar Event Settings
put
Get Do Not Disturb Settings
get
Update Do Not Disturb Settings
put
Create Calendar Event
post
Get Calendar Events
get
Create Calendar Event For User
post
Update Calendar Event
patch
Delete Calendar Event
del
Get Calendar Event Details By Event Id
get
Get Available Slots
get
Get Available Users by Date
get
Create Calendar Event By User Id
post
Get Calendar Events By User Id
get
Update Calendar Event By User Id
patch
Get Calendar Events By Users
get
Resources
Create a new resource
post
GET User Resource
get
Get Client Resources.
get
Creates a Resource Folder
post
Add a Subfolder to an Existing Folder
post
Update Resource Folder
patch
Update Resource
patch
Add Sub Resource
post
Get Resource By Id
get
Delete Resource By Id
del
Copy resources
post
Get Resource By Content Group Id
get
Remove Resource Language By Id
del
Medication
Search Medication By Name
get
Get Medication Monograph
get
Add Medication
post
Get Medications
get
Add Medication By User ID
post
Get Medications by User ID
get
Get Scheduled Medications
get
Get Scheduled Medications By User ID
get
Get Surescript Medications By User ID
get
Delete Surescript Medications By User Id
del
Get User Surescript Medications
get
Delete User Surescript Medication
del
Delete Pending Medication
del
Get Pending Medications
get
Get Medication Details
get
Delete Medication
del
Update Medication
patch
Delete Medication By User ID
del
Update Medication by User ID
patch
Batch Update of Medication Status
patch
Batch Update of Medication Status by User ID
patch
Get Medication History
get
Vitals
Retrieve User Vitals
get
Add User Vitals
post
Get Vitals By User Id
get
Add Vitals By User Id
post
Update User Vitals Alert Settings
patch
Update Alert Settings By Type
patch
Update user's vital alert settings by userId
patch
Get Vital Reading
get
Post Vital Reading
post
Get Granularity Graph Data Reading
get
Get Granularity Graph Data Reading
get
Get User Vital Reading
get
Update Alert Settings By User Id
post
Auth
Register User
post
Reset the user password.
patch
Initiate the password reset process by sending a reset notification.
post
User
Update User Details
patch
Get List Of Users For Current User
get
Activate Invited User
patch
Update User Settings
patch
Update User Settings
patch
Delete User
patch
Update User Details By Id
patch
Update User External Ids
patch
Check User Already Exists
get
Search User By Name
get
Search User By ID or User Name
get
Add Roles To Self
post
Remove Role From User By User Id
del
Remove Role From User
del
Get Users By Role Id
get
Delete User By Id
del
Get User By Id
get
Get Client Users
get
Get List Of Unique Values for User Column
get
Get User By External Id
get
Get User Configuration
get
Demographics
Get User Demographics
get
Add User Demographics
post
Update User Demographics
patch
Get Demographics By User Id
get
Update Demographics By User Id
patch
Client
Get Client Details
get
Get All Clients
get
Get All Unique Values for given Column Name of Client
get
Get Settings for client
get
Update Client Settings
patch
Get Client By Id
get
Update Client By Id
patch
Update Client Settings
patch
Update AI Settings Mention
patch
Update AI Settings Mention By Id
patch
Update AI Settings Mention By Id
del
Get Client Roles
get
Get Client External Ids
get
Communication Templates
Retrieve Communication Template Groups
get
Get Communication Group By Id
get
Delete Communication Group By Id
del
Get Communication Templates By Id
get
Update Communication Template
patch
Create Communication Group
post
Notification Settings
Get Notification
get
Update User Notification Settings
patch
Get Client Notification Settings
get
Update Client Notification Settings
patch
Get Notification Settings By User Id
get
Update User Notification Settings By User Id
patch
Get Notification Subscription
get
Update Client Subscription Notification By Id
patch
Get Client Notification Subscription
get
Notifications
Role
Create Role
post
Retrieve the roles assigned to a specific user.
get
Retrieve all roles associated with a specific client.
get
Get Client Roles
get
Retrieve the roles assigned to a specific user
get
Fetches the role by provided id.
get
Update the details of an existing role, including its label, description, and permissions.
patch
Delete a specific role from the system.
del
Retrieve the scopes associated with a specific role.
get
Remove a specific scope from a role.
del
Assign a scope to a role.
patch
Add Dashboard To Role
post
Remove a dashboard from a role
del
Update Dashboard To Role
patch
Add a content group to a role
patch
Remove a content group from a role
del
Scope
Fetches all the scopes
get
Clinical Trial
Create Clinical Trial
post
Get User Clinical Trials
get
Get All Clinical Trials
get
Get All Clinical Trials
get
Get All Roles Participating In Clinical Trial
get
Get Groups for Clinical Trail
get
Get Client Clinical Trial
get
Get Clinical Trials By Client Name
get
Get Clinical Trial Details
get
Update Clinical Trial
patch
Delete Clinical Trial
del
Get Client Content Group
get
Get Participant Details
get
Update Participant Status
patch
Update Inclusion Criteria
patch
Update Exclusion Criteria
patch
Delete Client Clinical Trial
del
Add Content Group to Clinical Trial
post
Remove Content Group From Clinical Trial
del
Permissions PlatformUserRequired
get
Get Clinical Trial Participants For a Client
get
Invitation
Get Sent Invitations
get
Send Invitation
post
Send Invitation
post
AI
Retrieve Information
get
Retrieve Gen AI Suggestions
get
Track Suggested Message Usage
post
Retrieve Gen AI Suggestions Evaluation
get
Get observation summary for patient
get
Get Observation Summarization
get
Track Observation Summary Feedback
post
Refresh Observation Summarization
get
Fetches the trends
get
User Group
Create a New User Group
post
Get user groups for current user
get
Get Client Groups
get
Get Client Groups by Filter
get
Fetch Client Default User Groups
get
Retrieve User Group Details by ID
get
Update a group
patch
Delete User Group
del
Retrieve Users of a Group by Group ID
get
Get Groups By User Id
get
Add Users To Group
post
Remove User From Group
del
Remove User From Group
del
Disclaimer
Create Disclaimer
post
Get User Disclaimers
get
Get Client Disclaimers
get
Get Client Disclaimers Column Values
get
Get Disclaimer By Id
get
Update Disclaimer By Id
patch
Delete Disclaimer
del
Update User Disclaimer Status
patch
Widgets
Content Group
Create Content Group
post
Retrieve Content Groups by User ID
get
Add vital sign To Content Group
patch
Create System Content Group
post
Get System Content Groups
get
Add Medications To Content Group
post
Get Medications Of Content Group
get
Update Medication To Content Group
patch
Delete Medications From Content Group
del
Get Client Content Groups
get
Get Client Content Groups
get
Get Content Group By Id
get
Update Content Group
patch
Delete Content Group
del
Add Disclaimers To Content Group
post
Delete Disclaimer From Content Group
del
Add Resource To Content Group
post
Delete Resource From Content Group
del
Get Content Groups By Role Id
get
Get Multiple Content Data By Id
get
Get Content Groups Resource By Id
get
Add Alert Resolution To Content Group
post
Delete Alert Resolution From Content Group
del
Get Content Group Alert Resolutions
get
Update Programs To Content Group By Content Group Id
post
Delete Program From Content Group By Content Group Id
del
Update Programs To Content Group By Content Group Id
post
Delete AdHoc Assessment From Content Group
del
Update Goal To Content Group
post
Remove Goal From Content Group
del
Update Single Task To Content Group
post
Remove Single Task From Content Group
del
Badges
Get Message Badge
get
Get Alert Badge
get
Chat
Get Communication Token
post
Get Communication Id of a user
get
Get Chat Threads
get
Get My Teams Chat Threads
get
Get Chat Threads By User Id
get
Get Thread Messages By Thread Id
get
Get Attachment File
get
Update Thread Metadata
patch
Get Message Metadata
get
Delete Message Metadata
del
Join Conversation
patch
Affiliation
Fetches the affiliation codes linked to the client
get
Fetches the details of the affiliation code.
get
Get Npi Information by Affiliation Code
get
Applications
Update Application
patch
Programs
Get Programs
get
Tableau
Get Tableau Token
post
Profile
Update User Profile
patch
Medical Summary
Get User Profile
get
Get Vitals By User Id
get
Add Vital By User Id
post
Get User Profile By User Id
get
Get All Vitals By User Id
get
Get Contact Information By User Id
get
Deactivate User
patch
Get Vital Type Details By User Id
get
Update Contact Information By User Id
patch
Activate User
patch
Get Vital Alert Threshold
get
Get User Deactivate/Activate History
get
Enable Vital Alerts
patch
Update Vital Settings
patch
Add Vital Alert Thresholds
post
Delete Vital Alert Thresholds
del
Delete Vital Entry
del
Get User Hospitalization
get
Get User Hospitalization By User Id
get
Get Allergy By User Id
get
Add Allergy By User Id
post
Update Allergy By User Id
patch
Delete Allergy By User Id
del
Get Allergy History By User Id
get
Get Immunization
get
Get Immunization By User Id
get
Get User Groups By User Id
get
Get User Groups History By User Id
get
Get User Pharmacy Details
get
Get User Pharmacy Details By User Id
get
Get Active Medications By User Id
get
Get Inactive Medications By User Id
get
Get Programs By User Id
get
Get Programs History By User Id
get
Update Programs By User Id
patch
Get Diagnosis By User Id
get
Update Diagnosis By User Id
patch
Get Encounters
get
Get Encounters By User Id
get
Add Encounter
post
Update Encounter
patch
Delete Encounter
del
Get Notifications By User Id
get
Get Active Guided Session By User Id
get
Get Inactive Guided Session By User Id
get
Get Guided Session User Responses
get
Get Guided Session History Details
get
Get Assessments Information By User Id
get
Get Assessments Graphs Data
get
Get Alerts By User Id
get
Get Alers For Last 30 Days By User Id
get
Get Alers Status By User Id
get
Get Most Reported Alerts By User Id
get
Get Alerts Severity By User Id
get
Update Alert
patch
Insurance
Get Insurance of User
get
Add Insurance
post
Get Insurance By User Id
get
Add Insurance
post
Update Insurance
patch
Update Insurance
patch
User Contact Details
Video
/video/creds
get
/video/call
post
Alert
Get Alert By ID for Specific User
get
Get Alerts By User Id
get
Resolve Alert By User Id
patch
Resolve All Alerts By User Id
patch
Video Lobby
Create Video Lobby
post
Get Rooms By Client
get
Get Rooms By Client
get
Get Rooms By User
get
Get Room By Id
get
Update Room Participants
patch
Delete Room
del
Handle Recording Operation
post
Get Video Lobby Recordings
get
Get Video Lobby Recordings By Column Name
get
Get Video Lobby Recording Details
get
Report
Create Standard Report
post
Create Standard Report
post
Create Report
post
Get Reports
get
Get Report By Id
get
Update Report
patch
Download Report
get
Get User Alert Report
get
Get User Health Summary Report
get
Get Provider Notes Report
get
Get User Vitals Report
get
Get User Medication Report
get
Notes
Get Notes For Other user
get
Add Note for other user
post
Get Notes
get
Add Note
post
Update Note
patch
Delete Note
del
Update Note for other user
patch
Delete Note for other user
del
Add Note reach patient
post
Get Notes For Reach Patients
get
Add Note reach HCP
post
Get Notes For Reach Patients
get
Update Note of a reach
patch
Delete Note of a reach
del
Alert Resolution
Create Alert Resolution
post
Get Alert Resolutions
get
Get Alert Resolution By Id
get
Update Alert Resolution
patch
Delete Alert Resolution
del
Get Alert Resolution For User
get
User List
Get User List Monitoring
get
Location
Add Location
post
Get Locations
get
Get Location Filter Options Values
get
Get Location By Id
get
Update Location
patch
Delete Location
del
Add User To Location
post
Delete User From Location
del
Audit Trail
Get Audit Trail
get
Get Route To get the Filter Values for the drop down
get
Get CSV file Audit Trail
get
Documents
Add Document By User Id
post
Get Documents By User Id
get
Create Document
post
Get Documents
get
Add client document
post
Get Client Documents
get
Delete Document
del
Update Document
patch
Get Document By Id
get
Delete Client Document
del
Update Client Document
patch
Guidedsession
Get Guided sessions for user based on the programs
get
Post step for user Guided session
post
Get Guided sessions history for user
get
Get inactive guided sessions history for user
get
Get Guided sessions for user based on the programs
get
Get guided session schedule for user
get
Integration
Get validic user and external URL
get
Get user gamification records
get
Get user healthwise records
get
Handle Zendesk operation
post
HealthTracker
Post question/answer for user Guided session programs
post
Post question/answer for user Guided session programs
post
Retrieve guidance for a specific date
get
Get user question level guidance from date
get
Get user question level guidance from date
get
Get Health Tracker library
get
Get Assessments Information By User Id
get
Get Assessments Graphs Data
get
Out Of Office
update users out of office settings
patch
Get users out of office settings
get
reset users out of office setting
patch
Get client out of office settings
get
update clients out of office settings
patch
Out Of Business Hours
update out of business hours settings
patch
get out of business hours settings
get
reset out of business hours settings
patch
get client out of business hours settings
get
update out of business hours settings
patch
Adhoc
Get Adhoc Question Of Content Group
get
Get Adhoc Question Of Content Group
get
Get Adhoc History
get
Get Adhoc history for User
get
Get Adhoc history for User
get
Ad hoc response by user
get
Get Adhoc show status
get
Update or insert Adhoc show status
patch
Get Adhoc question by id
get
Get Adhoc question by id
get
Reach Trials
Create System Level Reach Trial
post
Get System Reach Trials
get
Create Custom System Level Reach Trial
post
Get System Reach Trials By Id
get
Delete System REACH Trial
del
Get List of Unique Values for Reach Trial Column
get
Get Reach Trials from GOV API
get
Add Reach Trial to a client
post
Get Client Reach Trials
get
Remove Reach Trial from a client
del
Get List of Unique Values for Reach Trial Column at Client level
get
Add Reach Trial To Content Group
post
Removed Reach Trial from a content group
del
Enroll Patient to a reach trial
patch
Get patient's latest reach status
get
Get patient's Condition data
get
Get patient's Labs data
get
Patient details for a reach trial
get
Invite Patient to a reach trial
post
Get Reach Trials By Id
get
Reach Dashboards
All matched patients for Principal Investigator
get
Get all column value for PI's Patient
get
All matched patients for Principal Investigator
get
Get all column value for PI's Patient
get
All matched patients for HCP
get
Get all column value for PI's Patient
get
All matched Providers for a Reach Trial
get
Get all column value for operations Providers
get
All matched Providers for a Reach Trial
get
Get all column value for sponsor's Providers
get
Patients status by count for a trial
get
Patients status by count of a trial for a User
get
Patient count by reach trial
get
List of provider by statue for a reach trial
get
Count of patients per provider for a reach trial
get
Reach Criteria
Get all inclusion and exclusion criteria of a trial
get
Get all inclusion and exclusion criteria of a trial for a patient
get
Get all inclusion and exclusion criteria of a trial for a patient
patch
Tasks
Get All Tasks for dashboard
get
Create Custom Task
post
Get Task Details
get
Get Client Task Library
get
Get System Tasks
get
Create Tasks on System Level
post
Get Client Tasks
get
Create Tasks on Client Level
post
Get User Tasks by taskId
get
Update Task for User
patch
Copy Task on Client Level
post
Copy All Content Group Tasks
post
Patch System Task based on Id
patch
Remove System Task
del
Patch Client Task based on Id
patch
Remove Client Task
del
Get Goals associated with Task
get
Remove Language Task
patch
Create Custom Task for User
post
Create Custom Task for User Goal
post
Create Custom Task for User Goal
post
Assign Task from Library to User
post
Remove User Task from Library
del
Update Task for User
patch
Delete User Task
del
Update Task Status for User
patch
Update Task Status for User
patch
Guidance-Templates
Create a new guidance template
post
Get guidance templates for client
get
Search guidance template
get
Get Guidance Template by ID
get
Update a guidance template
patch
Delete a guidance template
del
Delete a guidance template
del
Caregiver
/caregiver/{id}
patch
/caregiver
get
/caregiver/switch/{to}
get
Powered by
Update Note
Ask AI
patch
https://api.medocity.net/v3/notes/
{noteId}
Used to Update Note.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
Response
Click
Try It!
to start a request and see the response here!
