Jump to Content
Home
Guides
API Reference
API Changelog
v1.0
API Reference
Log In
Jump to Content
v1.0
Home
Guides
API Reference
API Changelog
Create a New Consultation
Log In
All
Pages
Start typing to search…
JUMP TO
Overview
API Reference Overview
Public API
Overview
Products
List All Product Categories
get
List Products
get
Retrieve Product by ID
get
Carts
Retrieve Cart Theme
get
Retrieve Checkout URL
get
Retrieve Cart by ID
get
Get Related Products for a Cart
get
Create Cart
post
Add Item to Cart
post
Update Cart Item
put
Delete Cart Item
del
Leads
Check Lead by Email
post
Check Lead by Phone
post
Forms
Retrieve form by ID
get
Submit a Form
post
Appointments
Cancel Appointment with OTP
post
Cancel Appointment by ID
get
Retrieve Appointment by ID
get
Retrieve Start URL
post
Create Appointment
post
Services
List Available Services.
get
Get Appointment Consent Information
get
Retrieve Service by ID
get
Retrieve Service Availability
get
Webhooks
Handle incoming events from a specific source.
post
Handle incoming form-related events.
post
Patient API
Overview
Auth
Authenticate Patient with Password
post
Authenticate Patient with Verification Link
post
Request Password Reset Token
post
Validate Password Reset Token
get
Reset Patient Password
post
Patient
Create a Patient
post
Retrieve Patient Profile
get
Retrieve Patient Account Data
get
Retrieve App Layout
get
Update Patient Profile
put
Change Patient Password
post
Retrieve Billing Dashboard URL
get
Retrieve Patient Payment Methods
get
Add Patient Payment Method (v2)
post
Retrieve Addresses
get
Update Addresses
put
Retrieve Patient Identifiers
get
Add Patient Identifier
post
Delete Patient Identifier
del
Update Patient Identifier
put
Set Default Address
post
Retrieve Persona Link
post
Products
Retrieve Product by ID
get
List Products
get
Checkout
Start Checkout
get
Retrieve Checkout Cart
get
Apply Coupon to Cart
post
Create Payment and Orders
post
Check Payment Status
get
Orders
Create an Order
post
Pay Invoice with Payment Method
post
List Patient Orders
get
Retrieve Order Details
get
Subscriptions
List Subscriptions
get
Retrieve Subscription by ID
get
Update Subscription
put
Purchases
List Patient Purchases
get
Retrieve Purchase History by Product
get
Retrieve Specific Purchase Item Details
get
Prescriptions
List Prescriptions
get
Consultations
Create a Consultation
post
List Consultations
get
Update a Consultation
put
Retrieve Consultation by ID
get
Retrieve Required Consultation Forms
get
Delete Draft Consultation
del
Files
Retrieve File by Name
get
Upload Multiple Files
put
Upload Single File
put
Messages
List Messages
get
Retrieve Message by ID
get
Inbound Web Message
post
Update SMS Delivery Status
post
Appointments
Create an Appointment
post
List Appointments
get
Retrieve Appointment by ID
get
Update an Appointment
put
Retrieve Queue Position
get
Lab
Retrieve Lab Requisition by ID
get
Notifications
List Notifications by Type
get
Chat
Join Chat
put
Refresh Chat Token
put
Tasks
List Tasks
get
Logs
Retrieves Weight Logs
get
Creates a New Weight Log
post
Retrieve All Patient Logs
get
Update Injection Log
put
Retrieve Recent Activities
get
Delete Injection Log
del
Create Injection Log
post
Retrieve Injection Logs
get
EMR API
Overview
Patients
List Patients
get
Create a New Patient
post
Patients Lookup
get
Retrieve Patient by ID
get
Update Patient Profile
put
Deactivate Patient
del
Update Patient Watchlist
put
List Patient Files
get
Retrieve Patient File by Name
get
Upload Patient File
put
Delete Patient File
del
List Patient Payment Methods
get
Consultations
List Consultations
get
Create a New Consultation
post
Retrieve Latest Consultation by Type
get
Retrieve Consultation by ID
get
Update Consultation
put
Products
Retrieve Product Variants
get
List Product Categories
get
List Products by Category
get
List All Products
get
Orders
Retrieve Order by ID
get
Update Order Details
put
List Orders
get
Create a New Order
post
Retrieve Order Products
get
Retrieve Order Requirements
get
Charge Order Payment
put
Invoices & Coupons
List Invoices
get
Send Invoice Email to Patient
post
List Coupons
get
Create a New Coupon
post
Update Coupon
put
Delete Coupon
del
Drugs
List Drugs
get
Create a New Drug
post
Bulk Create Drugs
post
Update Drug
put
Delete Drug
del
Notes & Activities
List Notes
get
Create a New Note
post
Retrieve Note by ID
get
Update Note
put
Retrieve Session Report Note
get
List Activities
get
Create a New Activity
post
Retrieve Activity by ID
get
Update Activity
put
Notifications & Messages
List Admin Notifications
get
Dismiss All Notifications
put
Dismiss Single Notification
put
List Inbox Messages
get
List Conversation Messages
get
Send Outbound Message
post
Upload Message File
put
Forward Message
post
Join Chat Session
put
Refresh Chat Token
put
Prescriptions
Retrieve Prescription by ID
get
Update Prescription
put
List Prescriptions
get
Create a New Prescription
post
Send Prescription by Fax
post
Add Prescription Fulfillment
post
Appointments
List Appointments
get
Create a New Appointment
post
List Appointments Seen by Me
get
Retrieve Appointment by ID
get
Update Appointment
put
Pull Next Appointment from Queue
put
Fetch Appointment Virtual Meeting Details
put
Subscriptions
List Subscriptions
get
Cancel Subscription
del
Lab Requisitions
List Lab Requisitions
get
Create a New Lab Requisition
post
Update Lab Requisition
put
Delete Lab Requisition
del
System Users & Templates
List Organization Users
get
Retrieve Admin User by ID
get
Email Template Lookups
get
Get Invoice Email Template
get
Retrieve Email Template by ID
get
Send Test Email
post
Tasks
Retrieve Task by ID
get
Update Task
put
Delete Task
del
List Tasks
get
Create a New Task
post
CRM API
Overview
Application
Retrieve Application Layout
get
Authentication
Authenticate CRM User
post
Register a New CRM User
post
Users
Retrieve Current User Profile
get
Retrieve Current User's Schedule
get
Update Current User's Schedule
put
Search for Users
get
Retrieve User by ID
get
Delete a User
del
List Organization Users
get
Update a User's Profile
put
Reset a User's Password
put
Grant Permission to a User
post
Update User Permissions
put
Leads
Search for Leads
get
Download a Lead's File
get
Delete a Lead's File
del
Upload a File to a Lead
post
Retrieve Lead by ID
get
Update a Lead
put
Delete a Lead
del
List and Filter Leads
get
Create a New Lead
post
Bulk Upsert Leads
patch
Bulk Update Leads
put
Convert Lead to Patient
put
Retrieve EMR ID by Health Card
get
Tasks
List and Filter Tasks
get
Create a Task
post
Retrieve Task by ID
get
Update a Task
put
Delete a Task
del
Services
Search for Services
get
Retrieve Service by ID
get
Update a Service
put
List and Filter Services
get
Create a Service
post
Deactivate a Service
post
Add Schedule to Service
post
Remove Schedule from Service
del
Retrieve Service Availability
get
Appointments
List and Filter Appointments
get
Create an Appointment
post
List Available Providers
get
Assign Provider to Appointment
put
Retrieve Appointment by ID
get
Update an Appointment
put
Schedules
Search for Schedules
get
Sync Schedule by ID
get
Retrieve Schedule by ID
get
Update a Schedule
put
Delete a Schedule
del
List and Filter Schedules
get
Create a Schedule
post
Recurring Tasks
Search for Recurring Tasks
get
Retrieve Recurring Task by ID
get
Update a Recurring Task
put
Delete a Recurring Task
del
List Recurring Tasks
get
Create a Recurring Task
post
Forms
Search for Forms
get
Retrieve Form by ID
get
Update a Form
put
Delete a Form
del
Retrieve Form by Name
get
List and Filter Forms
get
Create a Form
post
Layouts
Retrieve Layout by ID
get
Update a Layout
put
Delete a Layout
del
Retrieve Layout by Name
get
List Layouts
get
Create a Layout
post
Workflows
Search for Workflows
get
Retrieve Workflow by ID
get
Update a Workflow
put
Delete a Workflow
del
Retrieve Workflow by Name
get
List Workflows
get
Create a Workflow
post
Test a Workflow
post
CRM Schema
Retrieve Schema by ID
get
Update a Schema
put
Delete a Schema
del
Retrieve Schema by Name
get
List Schemas
get
Create a Schema
post
Campaigns
Launch a Campaign
post
Retrieve Campaign by ID
get
Update a Campaign
put
Delete a Campaign
del
List Campaigns
get
Create a Campaign
post
Segments
Search for Segments
get
Retrieve Segment by ID
get
Update a Segment
put
Delete a Segment
del
List Segments
get
Create a Segment
post
Settings
Retrieve Organization Settings
get
Update Organization Settings
put
Email Templates
Search for Email Templates
get
List Email Templates
get
Create an Email Template
post
Retrieve Email Template by ID
get
Update an Email Template
put
Delete an Email Template
del
Clone an Email Template
post
Send a Test Email
post
Customers
Search for Customers
get
List Customers
get
Retrieve Customer by ID
get
Products
Search for Products
get
Retrieve Product by ID
get
Update a Product
put
List and Filter Products
get
Create a Product
post
Powered by
Create a New Consultation
Ask AI
post
https://emr-api.portals.care/consultations
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
