For AI agents: the docs index is at https://developers.optt.health/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
API Reference
Changelog
v1.0
AI
webhook- notification
Magic_link
Triage
Log In
API Reference
Log In
Triage
Home
Guides
API Reference
Changelog
My Requests
My Requests
Awesome New API
Getting Started with OPTT-library
Getting Access and Authorization via OAuth Token:
How to REFRESH TOKEN
caregiver-session-controller
How to Creating a Session by a Care Provider (and assigning homework)
list all of session for a caregiver
How to access the session data: Care Provider
How to close a session
Client-Session-Controller
List of all Sessions
How to access the session data: Client
Caregiver-assign homework
How to Assign homework to the Client
List of Assignments created by the Care Provider
Details of each Assignment
Client-Assignment
List of Assignments of each Client
How to submit homework
Feedback
How to Provide Feedback
Commenting on Feedback by a Care Provider
SSO
SSO
Creating a Client
Creating a Design Plan for the client as a Clinic
Showing the list of all Design Plans created by the Clinic
Creating a Client account through Clinic
Creating a care provider
How to add a care provider
Profile APIs
caregiver-controller
get Caregiver data by Caregiver principal
get
update Caregiver
put
Gets caregiver's announcements
get
get module by id
get
Retrieve all clients of a caregiver
get
Gets all questioner test client
get
Get List of all clients Partial details
get
get a client data
get
Retrieve all caregiver of a client
get
Creates a Video Appointment for this caregiver and his client
post
Retrieve Dashboard info for a caregiver
get
getting DesignPlan list per caregiver
get
Creating a new Design Plan
post
update design plan
put
Eliminating a Design-Plan by id
del
get a DesignPlan by Id
get
Get Document list
get
Creating a new Document
post
retrieve a document
get
Eliminating a Document by id
del
Gets all Feedback Templates
get
change client language
put
Calls Sensitive Word Check and Sends Appropriate Notifications
get
Gets caregiver's settings
get
updating caregiver settings
put
Gets all appointments data corresponding the caregiver
get
Gets the appointment's data corresponding the given Id
get
caregiver-feedback-controller
list Assignment Feedbacks or comments of a feedback or autoSave of them
get
post a feedback or comment
post
Get feedback model by caregiver
get
module-controller
Get Modules list by caregiver
get
Get Modules list by clinic
get
caregiver-note-controller
Gets all Notes for a Session
get
adds a note to this session by caregiver
post
caregiver-session-controller
get session list for a caregiver
get
Create a session
post
Update a session by caregiver
put
list assignments of a caregiver
get
assign an assignment to a session
put
Get answer data
get
Update Assignment
put
list assignments of a caregiver
get
Delete assignment
del
get session for a client by a caregiver
get
Get a list of client assignments by a caregiver
get
assign a document to a session
put
get assignment score history of client for an assignment by a caregiver
get
Get session data
get
delete a session by id
del
close a session by a caregiver
put
chat-controller
Send chat message email for caregiver
post
client-controller
retrieve a client profile
get
updating a client by id
put
get module bytes by id
get
Gets client's caregiver
get
Get client's clinic data
get
Create a new Client by CPM
post
Create a new Client by CPM
post
Gets client's dashboard information
get
get module by id
get
get module by id
get
change client language
put
Gets client's settings
get
updating client settings
put
client-feedback-controller
List feedbacks or comments or get autoSave of feedback or comment
get
post a comment , or reply of a comment for a feedback
post
Update feedback as seen
put
List feedbacks of a session
get
Get feedback model by client
get
client-session-controller
List Sessions
get
List assignments
get
Get answer data
get
Post Assignment answer
post
List assignment answer drafts
get
Get Client Last Session Goal
get
Get Assignment data
get
Get Client Session Dashboard
get
Get session data
get
List assignments of a session by sessionId
get
clinic-controller
getting Clinic data by email
get
update Clinic
put
get module by id
get
Bulk reset users password by selected list or all users
post
retrieve a Clinic by cmp token
get
Get clinic cpm link
get
Get clinic dashboard information
get
getting DesignPlan list per clinic
get
Creating a new Design Plan
post
update design plan
put
Eliminating a Design-Plan by id
del
get a DesignPlan by Id
get
Get Document list
get
Creating a new Document
post
retrieve a document
get
Eliminating a Document by id
del
get provinces list
get
Update clinic terms and condition page link
put
getting Clinic data by email
get
clinic-caregiver-controller
List Caregivers partial pageable
get
create a new caregiver
post
Update Cargiver
put
Get All Announcements of this clinic
get
Create an announcement by clinic for regarding all it's caregivers
post
Get Announcement by it's id
get
Get Announcement by it's id
del
List Caregivers partial all
get
get Caregiver Positions list
get
Get Caregiver of the Clinic
get
Get Caregiver of the Clinic
del
Get Caregiver assigned Clients of the Clinic
get
add clients to a caregiver
put
Get Caregiver sessions of the Clinic
get
clinic-client-controller
Retrieve all clients
get
Creating a new Client
post
updating a client by id
put
Retrieve all clients coming from CPM
get
Update Cpm client , reject or create client
put
Retrieve all clients coming from CPM
get
Retrieve all clients
get
retrieve a client
get
eliminating a client by id
del
get all caregivers of the client
get
assign caregivers to the client
post
clinic-client-invoice-controller
updating client invoice by stripe webHook endPoint
post
getting invoice data by invoiceId
get
clinic-session-controller
Create a session by clinic
post
Update a session by clinic
put
Update Assignment
put
Delete assignment
del
List client sessions by clinic
get
List client Assignments by clinic
get
institute-controller
get module by id
get
Bulk reset users password by selected list or all users
post
Retrieves institute dashboard information
get
get all documents
get
create institute
post
get document id
get
get domains list
get
retrieves all Feedback Templates
get
institute makes a feedback template
post
institute updates a feedback template
put
retrieve a Feedback Template by Id
get
remove a Feedback Template by Id
del
institute-caregiver-controller
List Caregivers of Institute
get
Create Caregiver by Institute
post
update Caregiver
put
List Caregivers of Institute
get
eliminating a caregiver by id
del
getting Caregiver profile sessions by Id
get
getting Caregiver profile sessions by Id
get
getting Clinic data by Id
get
institute-caregiver-position-controller
get Caregiver Positions list
get
create Caregiver Position
post
update Caregiver Position
put
get Caregiver Position
get
Delete Caregiver Position
del
institute-client-controller
Retrieve all clients in the institute
get
create client by institute
post
updating a client by id
put
Retrieve all clients in the institute
get
Retrieve a client in the institute
get
eliminating a client by id
del
Retrieve client's sessions in the institute
get
get client's caregivers by institute
get
Retrieve client's sessions in the institute
get
institute-clinic-controller
getting Clinic list , by page
get
creating a new Clinic
post
update Clinic
put
getting Clinic list ,Lov
get
getting Clinic profile
get
getting Clinic data by Id
get
institute-clinic-admin-controller
getting Clinic user list
get
creating a new Clinic user
post
update Clinic
put
getting Clinic user data by Id
get
optt-admin-user-controller
retrieve an assigment detail by id
get
retrieve client report based on report type
get
retrieve all type of reports
get
Retrieve all caregivers
get
Retrieve all clients
get
Retrieve all Clinics
get
test-controller
initDomain
post
identity-resource
The user is added to the users with userId and returns the user's token
post
The user is added to the users with userId and returns the user's token
post
user-controller
Verify captcha
post
List Clinics of a caregiver in different institutes
get
changing password of a user by institute or clinic
put
changing password of a user by optt admin
put
get client by principal
get
resend activation email
post
get user list by keyword in email or name
get
get client by principal
get
resend activation email
post
set password for client
put
Powered by
••••••9a70
Endpoint
Method
Status
User Agent
