Jump to Content
User Guide
API Reference
v2.3.10
v2.3.15
v2.3.22
v2.3.27
v2.3.28
v2.3.29
v2.3.30
v2.3.33
v2.3.34
v2.3.35
v2.3.38
v2.3.39
Product
Use Cases
Resource Center
FAQ
About Us
Book a Demo
Sign Up - It's Free
API Reference
Product
Use Cases
Resource Center
FAQ
About Us
Book a Demo
Sign Up - It's Free
v2.3.39
User Guide
API Reference
The BioT API - Getting Started
All
Pages
Start typing to search…
JUMP TO
The BioT API
The BioT API - Getting Started
BioT User Management Service
User API
Generate a new password for a User
post
Validate user credentials
post
Get User by ID
get
Delete User
del
Update User
patch
Search User entities by filter
get
Login API
Refresh JWT token
post
Login with refresh token
post
Login with OTP
post
Generate login OTP
post
Logout
post
Login with credentials
post
Self User API
Self get user
get
Self registration of User
post
Self delete user
del
Self update user
patch
Send reset password message
post
MFA Login API
MFA login
post
Resend SMS for MFA verification
post
Service User API
Search Service User entities by filter
get
Create a new Service User
post
Create a new Service User
post
Service User Login
post
Get Service User by ID
get
Delete Service User
del
Update Service User
patch
Delete secret key of a service user by service user id and secret key id
del
Temporary Token Operation API
Validation token operation
get
Execute token operation
post
Execute token operation
get
Temporary Credentials API
Get MQTT temporary credentials for receiving notification for all entities in an organization.
get
Security API
Get public key
get
Health Check API
Service Health check API
get
BioT Settings Service
Template API
Get Template by ID
get
Update Template
put
Delete Template
del
Search Template entities by filter
get
Create a new Template
post
Get template overview
get
Search Template entities by filter
get
Plugin-V2 API
Search Plugin entities by filter
get
Create a new Plugin
post
Get plugin by name
get
Delete Plugin
del
Update Plugin
patch
Get temporary credentials for the docker repository
get
Translation API
Validate translations for locale
post
Update translations for locale
patch
Download locale translation file
get
Search Locale translations overview entities by filter
get
Delete all translations for locale
del
System API
Reset system
post
Get system properties
get
Backup API
Backup
post
Search Restore entities by filter
get
Search Backup entities by filter
get
Locale API
Add locale to the available locales
post
Get available locales, the default locale and the system locale
get
Update available locales and/or the system default locale.
patch
Remove a locale from the available locales
del
Export Import Configuration API
Start import configuration
post
Start export configuration
post
Get the last import execution
get
Get exported files metadata
get
Get the last export execution
get
Code Snippet API
Create a new Code snippet
post
Get Code snippet by ID
get
Delete Code snippet
del
Entity API
Get all Entity types
get
Get all notifiable actions
get
Get all Entity types
get
Get all notifiable actions
get
Interception Configuration API
Search Code snippet entities by filter
get
Search Interception Configurations entities by filter
get
Health Check API
Service Health check API
get
BioT Device Service
Device API
Search Device entities by filter
get
Create a new Device by Template id
post
Create a new Device by Template name
post
Get Device by ID
get
Delete Device
del
Update Device
patch
Get Device Connection Details by ID
get
Device Certificate API
Create new Certificate for Device
post
Delete Certificate for Device
del
Activate Certificate for Device
post
Temporary Token Operation API
Validation token operation
get
Execute token operation
post
Execute token operation
get
Usage Session API
Create a new Usage Session by Template id
post
Create a new Usage Session by Template name
post
Get Usage Session by ID
get
Delete Usage Session
del
Update Usage Session
patch
Search Usage Session entities by filter
get
Search currently in progress devices' sessions entities by filter
get
Delete Usage Session
del
Usage Session Remote Control API
Stop an existing Usage Session
post
Resume a paused Usage Session
post
Pause an existing Usage Session
post
Create and start a Usage Session
post
Command API
Start a new command by name
post
Stop an existing Command
post
Start a new command
post
Get Command by ID
get
Delete Command
del
Search Command entities by filter
get
Device Alert API
Create a new Device Alert by Template id
post
Create a new Device Alert by Template name
post
Get Device Alert by ID
get
Delete Device Alert
del
Update Device Alert
patch
Search open device's alerts entities by filter
get
Search Device Alert entities by filter
get
Temporary Credentials API
Get mqtt temporary credentials for device gateway
get
Get mqtt temporary credentials for receiving device measurements for all devices in an organization.
get
Endpoint API
Get endpoint
get
Health Check API
Service Health check API
get
BioT Dispatcher Service
Subscription API
Unsubscribe from notifications for actions
post
Subscribe to get notifications for actions
post
Search Subscription entities by filter
get
Interception API
Unsubscribe a specific endpoint from intercepting API(s)
post
Subscribe for intercepting APIs
post
Search for active interception subscriptions
get
Health Check API
Service Health check API
get
BioT Data Management Service
Temporary Token Operation API
Validation token operation
get
Execute token operation
post
Execute token operation
get
Report API
Cancel Report
post
Create a new Report
post
Search Report entities by filter
get
Get Report by ID
get
Delete Report
del
Analytics DB API
Stop Analytics DB Synchronization
post
Stop Analytics DB Initialization
post
Start Analytics DB Initialization
post
Get Analytics DB Information by ID
get
Get Analytics DB Connection Details by ID
get
Analytics DB State API
Stop Analytics DB Synchronization
post
Stop Analytics DB Initialization
post
Start Analytics DB Initialization
post
Get Analytics DB State
get
Analytics DB Connection API
Get Analytics DB Connection Details by ID
get
BI Dashboard API
Download PDF
get
Health Check API
Service Health check API
get
BioT Facade
Patient Sign Up API
Self sign up for patients
post
Anonymous self sign up for patients
post
Assign a device to a patient
post
Health Check API
Service Health check API
get
BioT Generic Entity Service
Generic Entity API
Search Generic Entity entities by filter
get
Create a new Generic Entity by Template id
post
Create a new Generic Entity by Template name
post
Get Generic Entity by ID
get
Delete Generic Entity
del
Update Generic Entity
patch
Health Check API
Service Health check API
get
BioT Measurement Service
Measurements API
Save measurement
post
Save measurements in bulk
post
Get raw measurements
get
Get aggregated measurements
get
Measurements V2 API
Search Raw Measurements entities by filter
get
Search Aggregated Measurements entities by filter
get
Health Check API
Service Health check API
get
BioT Notification Service
Configuration API
Get service configuration
get
Set service configuration
put
Get is sms provider configured
get
SMS API
Send sms
post
Email API
Send email
post
Add attachment
post
Health Check API
Service Health check API
get
BioT Organization Service
Landing Page API
Get landing pages by type
get
Set a landing page
put
Delete landing pages by type
del
Patient API
Search Patient entities by filter
get
Create a new Patient by Template id
post
Enable or Disable Patient User
post
Create a new Patient by Template name
post
Get Patient by ID
get
Delete Patient
del
Update Patient
patch
Search available organizations for sign up entities by filter
get
Get self Patient by ID from access token
get
Patient Alert API
Create a new Patient Alert by Template id
post
Create a new Patient Alert by Template name
post
Get Patient Alert by ID
get
Delete Patient Alert
del
Update Patient Alert
patch
Search open patient's alerts entities by filter
get
Search Patient Alert entities by filter
get
Organization User API
Search Organization User entities by filter
get
Create a new Organization User by Template id
post
Enable or Disable Organization User
post
Create a new Organization User by Template name
post
Get Organization User by ID
get
Delete Organization User
del
Update Organization User
patch
Get self Organization User by ID from access token
get
Caregiver API
Search Caregiver entities by filter
get
Create a new Caregiver by Template id
post
Enable or Disable Caregiver User
post
Create a new Caregiver by Template name
post
Get Caregiver by ID
get
Delete Caregiver
del
Update Caregiver
patch
Get self Caregiver by ID from access token
get
Temporary Token Operation API
Validation token operation
get
Execute token operation
post
Execute token operation
get
Registration Code API
Search Registration Code entities by filter
get
Create a new Registration Code by Template id
post
Create a new Registration Code by Template name
post
Get Registration Code by ID
get
Delete Registration Code
del
Update Registration Code
patch
Organization API
Search Organization entities by filter
get
Create a new Organization by Template id
post
Create a new Organization by Template name
post
Update Organization
post
Get Organization by ID
get
Delete Organization
del
Update Organization
patch
Invitation API
Resend Invitation by ID
post
User API
Get self User by ID from access token
get
Health Check API
Service Health check API
get
BioT File Service
Multiple Part File API
Upload ETags for parts of a multiple part file upload
put
Generate signed URLs for multiple part file upload
post
Create a new File
post
Complete multiple part file upload
post
Cancel multiple part file upload
del
File API
Create a new File
post
Get File by ID
get
Health Check API
Service Health check API
get
BioT Entity Service
Health Check API
Service Health check API
get
Powered by
The BioT API - Getting Started
Ask AI
