For AI agents: visit https://developerdocs.elabnext.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Guides
Recipes
API Reference
SDK Reference
v1.0
Support
Log In
API Reference
Search
Support
Log In
v1.0
Guides
Recipes
API Reference
SDK Reference
Authentication
JUMP TO
eLabNext REST API
Add-on licenses
List all active add-on licenses
get
List all expired add-on licenses
get
Purchase a license for an add-on
post
Start a trial for an add-on
post
Get the license of an add-on
get
List all add-on license types
get
Get the license type for an add-on
get
Update the license type for an add-on
put
Create a license type for an add-on
post
Delete the link between a license type and an add-on
del
Add-on OAuth
Get the OAuth 2.0 configuration for an add-on
get
Create an OAuth 2.0 configuration for an add-on
post
Get the OAuth 2.0 authorisation URI for an add-on
get
Get the current access token for an add-on
get
Exchange an authorisation code for an access and refresh token
post
Refresh the stored access and refresh tokens
post
Add-ons
Install an add-on bundle
post
List add-on bundles
get
Create an add-on bundle
post
Update an add-on bundle
put
Delete an add-on bundle
del
Get the current user's marketplace permissions
get
List target groups for an add-on
get
Add a target group
post
Remove a target group from an add-on
del
List groups that have this add-on installed but fall outside its targets
get
List target users for an add-on
get
Add a target user
post
Remove a target user from an add-on
del
List users that have this add-on installed but fall outside its targets
get
List target organisations for an add-on
get
Add a target organisation
post
Remove a target organisation from an add-on
del
Get mixed targets for an add-on
get
Update mixed targets for an add-on
put
Create mixed targets for an add-on
post
List add-on categories
get
Create an add-on category
post
Update an add-on category
put
Delete an add-on category
del
List registered add-on sources
get
Create a registered add-on source
post
Get a registered add-on source
get
Update a registered add-on source
put
Delete a registered add-on source
del
Get add-on-provided sample type metadata
get
Synchronise local add-ons with remote sources
get
Update all other installed versions of an add-on to this version
post
Uninstall an add-on for a given scope
post
Install an add-on for a given scope
post
Enable an add-on for a given scope
put
Get an available add-on by ID
get
Delete an installed add-on
del
List add-ons available in the marketplace
get
Disable an add-on for a given scope
put
List installed add-ons
get
Get an installed add-on
get
Get available add-ons grouped by rootVar
get
Get the configuration of an add-on
get
Set the configuration of an add-on
put
Update an add-on
put
Publish a new add-on
post
Approve an add-on for installation by end users
put
Add media to an add-on
post
Delete a media item from an add-on
del
List users with an add-on installed
get
List groups with an add-on installed
get
List institutes with an add-on installed
get
Get the count of available add-on upgrades
get
AI
Answer a single-prompt question using AI
post
Answer a follow-up question using AI
post
Authentication
Exchange an add-on request token for an API token
post
Get the current authentication details
get
Authenticate and obtain an API token
post
Get the current mobile app version for a platform
get
Currency
List available currency codes
get
List available currencies with their symbols
get
Experiment
Get the signature workflow for an experiment
get
Get experiments
get
Create a new experiment
post
Get an experiment by id
get
Get an experiment's change logs
get
Get collaborators for an experiment
get
Set up a new request to sign an experiment using SAML
post
Sign an experiment using SAML authentication
post
Sign an experiment
post
Assign a witness for an experiment signature
post
Set up a new request to pre-sign an experiment using SAML
post
Assign a witness for an experiment signature using SAML authentication
post
Decline a witness signature request on an experiment
post
Get pending witness signatures for the current user
get
Get declined witness signatures for the current user
get
Update the witness for an experiment
post
Get experiment template groups
get
Get experiment templates by templateCategoryID
get
Get experiment templates
get
Experiment Links
Get all experiments linked to a specified experiment
get
Link experiments to a specified experiment
post
Unlink experiments from a specified experiment
del
Experiment Sections
Get equipment list with bookings from an EQUIPMENT section
get
Remove equipment from an EQUIPMENT section
del
Get log list from an EQUIPMENT section
get
Create equipment links
post
Link equipment to a section and create a booking
post
Link equipment to a section and associate existing bookings
post
Create a new booking for an existing equipment link
post
Add existing bookings to an existing equipment link
post
Remove equipment bookings from an EQUIPMENT section
del
Get experiment sections
get
Create a new, empty section in an experiment
post
Get an experiment section
get
Archive an experiment section
del
Update an experiment section's general properties
patch
Restore an archived experiment section
post
Change the position of the section within the experiment
put
Copy an experiment section
post
Check if a text section has been locked
get
Try to lock a text section
put
Try to unlock a text section
del
Get the content from a text section
get
Update the content of a text section
put
Get a full HTML page from a section
get
Update a text section's HTML content
put
Get file list of a FILE or CUSTOM section
get
Upload a file to a FILE or CUSTOM section
post
Remove multiple files from a FILE or CUSTOM section
del
Download a file from a FILE or CUSTOM section
get
Remove a file from a FILE or CUSTOM section
del
Get the custom section information of a CUSTOM section
get
Create a blank OOS file of a given type
post
Check if the OOS file is empty
get
Get latest OOS file ID
post
Generate an access token for use in OOS integration
post
Restore OOS section to selected file and retake screenshot
put
Download the preview image from an OOS section
get
Get the URL to the OOS server
get
Download the Excel file from an EXCEL section
get
Upload an Excel file to an EXCEL section
put
Download the preview image from an EXCEL section
get
Get the URL to the OOS server for editing an EXCEL section
get
Download the canvas image from a CANVAS section
get
Upload an image to a CANVAS section
put
Get image list of an IMAGE or CUSTOM section
get
Upload an image file to an IMAGE or CUSTOM section
post
Remove multiple images from an IMAGE or CUSTOM section
del
Download an image from an IMAGE or CUSTOM section
get
Remove an image from an IMAGE or CUSTOM section
del
Update the description of an image in an IMAGE or CUSTOM section
put
Update the position of an image in an IMAGE or CUSTOM section
put
Download the image of a MARVINJS section
get
Get the image of a MARVINJS section as a data URL
get
Get the MarvinJS reaction data from a section
get
Post the MarvinJS reaction data to a section
post
Get the MarvinJS structure data from a section
get
Get the content from a DATATABLE section
get
Update the content of a DATATABLE section
put
Get sample list from a SAMPLESIN or SAMPLESOUT section
get
Add samples to a SAMPLESIN or SAMPLESOUT section
put
Remove samples from a SAMPLESIN or SAMPLESOUT section
del
Get all meta data in a section
get
Create or update meta data in a section
put
Create or update meta data in a section
post
Get meta data from a section by name
get
Experiment Sections (Deprecated Calls)
Get the content from a text section
get
Get a full HTML page from a section
get
Get file list of a FILE section
get
Download a file from a FILES section
get
Download the excel file from an EXCEL section
get
Download the preview image from an EXCEL section
get
Download the canvas image from a CANVAS section
get
Get image list of an IMAGE section
get
Download an image from an IMAGE section
get
Download a marvinJS image
get
Download a marvinJS image in Base64 format
get
Get sample list from a SAMPLESIN or SAMPLESOUT section
get
Features
List features
get
Check whether a feature is enabled
get
Enable a feature globally
post
Disable a feature globally
post
Enable a feature for specific groups
post
File and Meta File Storage
Get a file by group and file ID
get
Get a file from the current group
get
Delete a file from the current group
del
Get the latest version of a file from the current group
get
Get a meta file by group and meta file ID
get
Get a meta file from the current group
get
Upload a meta file
post
Convert a TIFF file to a PNG data URL string
get
List files
get
Upload a file
post
Upload a file to a staging area
post
Group
Get a group setting
get
Get group settings
get
Create a group setting
post
Get all settings for the currently active group
get
Create an active group setting
post
Get an active group setting
get
Update an active group setting
put
Delete an active group setting
del
Update a group setting
put
Delete a group setting
del
Get all groups for which you are a member
get
Get all subgroups for which you are a member
get
Get members of a group you are a member of
get
Get your currently active group
get
Change your currently active group
put
Search groups by name
get
Hybrid Storage
Export the local-storage file index for an institute
get
Export the local-storage file index for the current institute
get
Barcode
Look up the object type and ID for a barcode
get
Project
Get projects
get
Create a new project
post
Journal Notes and Dashboard Images
Get your notes
get
Create a new note
post
Delete several notes
del
Get a digest of all your notes
get
Get a note by id
get
Delete a note
del
Update a note's properties
patch
Get a digest of your note images
get
Upload a note image
post
Delete several note images
del
Download a note image by id
get
Delete a note image
del
Marketplace
Get an image by media ID
get
Get an icon by media ID
get
List all available add-ons
get
Get an available add-on by ID
get
Get the script code of an add-on
get
Check whether an add-on's dependencies are published
get
Check whether the current user has an add-on enabled
get
Measurement Unit
List measurement units defined by eLab
get
MessageQueue
Deliver a message to the message queue
post
Retrieve messages from the queue
get
Notification
Get digest information for all notifications
get
Send a notification
post
Get notifications by ID
get
Mark a set of notifications as read
post
Mark all notifications as read
post
Delete a set of notifications
post
Study
List studies
get
Create a study
post
Create a SAML sign request for a study
post
Office Online
Get the Office Online Server version
get
Get the Office Online locale for the current user
get
Organisations
Get an institute setting
get
Delete an institute setting
del
Get institute settings
get
Create an institute setting
post
Get the active institute settings
get
Create an active institute setting
post
Get an active institute setting
get
Update an institute setting
put
Update an active institute setting
put
Delete an active institute setting
del
Find organisations by name
get
Permissions
Change the default role for a new user
post
Get the default role for a new user
get
Disable a permission for a role
post
Enable a permission for a role
post
Get log records for permission changes
get
Get the roles for a subgroup
get
Clone a role
post
ProjectGroup
List project groups for a user
get
Set or unset a user as project group manager
put
Protocols
Get protocols
get
Get a protocol by id
get
Get a protocol by its version id
get
Get available protocol categories
get
Add a protocol category
post
Archive a protocol category
del
Get protocol digest
get
Get a protocol file
get
Change the subgroup for a protocol
post
Import a protocol from plain or HTML marked up text
post
Get log records for a protocol
get
Sign a protocol using SAML authentication
post
Witness sign a protocol using SAML authentication
post
Get possible sign witnesses for a protocol
get
Sign a protocol
post
Reassign a witness for a protocol signature
post
Decline a protocol sign request
post
Witness sign a protocol
post
Get declined witness signatures for the current user
get
Get pending witness signatures for the current user
get
Quantity
List quantity types
get
Get a quantity type by ID
get
Sample
Get samples
get
Create a new sample
post
Perform a similarity, substructure or exact search on chemical sample data
get
Create multiple new samples with metas
post
Archive multiple samples
del
Create a new sample by using HL7 2.x.x standards
post
Get a sample by id
get
Archive a sample
del
Update a sample's properties
patch
Get a list of samples for multiple ids
get
Get a list of samples for multiple barcodes
get
Get a list of samples for multiple names
get
Get a sample's full parent ancestry
get
Get a sample's direct children
get
Get all experiment sections where the sample is used
get
Archive multiple samples
post
Get single samples and sample series in an aggregated list
get
Move a sample to another storage layer
post
Move samples to another storage layer
post
Move samples to another storage layer
post
Change the locations of multiple samples in a box compartment
post
Change the locations of multiple samples
post
Creates one or more clones of a sample
post
Creates a series out of one or more clones of the specified sample
post
Clone sample into an existing series
post
Recover multiple archived samples
post
Get a sample's change logs
get
Add or replace quantity settings for all samples in a series
put
Add to quantity amount for all samples in a series
post
Subtract from quantity amount for all samples in a series
post
Add an amount to a sample's quantity
post
Subtract an amount from a sample's quantity
post
Clear a sample's amount
post
Clear amount of all samples in a series
post
Get all of a sample's meta fields
get
Create or update a sample's meta field
put
Create a new sample's meta field
post
Create or update multiple sample's meta fields
put
Get a sample's meta field by id
get
Delete a sample's meta field
del
Update a sample's meta field properties
patch
Create or update a sample's meta field properties in bulk, based on its sampleTypeMetaID
put
Check out a sample
post
Check in a previously checked out sample
post
Check out multiple samples
post
Check in multiple samples
post
Remove the location from multiple samples
post
Change the owner of a sample
post
Change the owner of multiple samples
post
Change the owner of multiple samples
post
Get sample series
get
Create a new sample series
post
Create a new sample series with samples, meta fields, and quantity settings
post
Add multiple samples to an existing sample series
post
Update a sampleseries properties
patch
Add a sample to a series
post
Update all samples in a sample series
patch
Get a sample series by id
get
Archive all samples in a series and remove the series
del
Add existing samples to a series
post
Merge source sample series into target sample series
post
Remove samples from a series
post
Move all samples in a series to another storage layer
post
Copy a sample series to the given location
post
Get a sample series' change logs
get
Get the available columns for the sample list table
get
SampleType
Get sample types
get
Create a new sample type
post
Get a list of sample types for multiple names
get
Get a sample type by id
get
Delete a sample type
del
Update a sample type's properties
patch
Restore the given sampleType from archive
post
Get all meta fields from all sample types
get
Get all of a sample type's meta fields
get
Create or update a sample type's meta field
put
Create a new sample type's meta field
post
Get a sample type's meta field by id
get
Delete a sample type's meta field
del
Update a sample type meta field's properties
patch
Get a sample type meta field's default options
get
Update, Remove and Create a sample type meta field's default options
put
Signature Workflows
List signature workflows
get
Create a signature workflow
post
Get a signature workflow
get
Archive a signature workflow
del
Publish a signature workflow
post
Add a signature workflow step
post
Change the name of a signature workflow
post
Change the description of a signature workflow
post
Delete a signature workflow step
del
List candidates with sign permission
get
List candidates with witness sign permission
get
List project candidates for signature workflows
get
List role candidates with sign permission
get
List role candidates with witness sign permission
get
Add one or more projects to a signature workflow
post
Remove one or more projects from a signature workflow
del
Update the assignee for a workflow step
post
List pending signatures for a signature workflow
get
Cancel all pending signatures of a signature workflow
post
Storage and Equipment
Get the active assignment of a compartment
get
Create a compartment assignment
post
Create assignments on multiple compartments
post
Delete assignments on multiple compartments
del
Update a compartment assignment
put
Delete a compartment assignment
del
Get equipment bookings
get
Create an equipment booking
post
Update an equipment booking
put
Delete an equipment booking
del
Get all storage unit/equipment types
get
Create a new equipment type
post
Get a storage unit/equipment type by id
get
Delete a storage unit type/equipment type
del
Get storage units/equipment
get
Create a new storage unit/equipment based on the specified type
post
Get a storage unit/equipment by id
get
Update properties of a storage unit or equipment
patch
Update properties of multiple storage devices or instruments
patch
Update icons of multiple instruments
patch
Get statistics for a storage unit
get
Get a storage unit's samples
get
Find a free sample location within a storage unit
get
Get a storage unit's full logs
get
Get full log of an equipment
get
Export a full log of an equipment
post
Find an empty compartment in a storage layer
get
Update the status of the given storage unit
put
Get an equipment reservations report
get
Get a storage unit's sample logs
get
Get all compartment definitions for a storage unit
get
Create a new compartment definition for a storage unit
post
Get a compartment definition by id
get
Get the storage compartment ancestry of a compartment
get
Get storage unit/equipment compartments
get
Get a storage unit/equipment compartment by id
get
Delete a storage compartment
del
Update a storage compartment's properties
patch
Get a storage unit/equipment compartment by its barcode
get
Get a storage compartment's logs
get
Get the storage compartments of a compartment
get
Create a new compartment within an existing compartment
post
Create multiple new compartments within an existing compartment
post
Get the storage compartments of several parent compartments
get
Move a storage compartment into another compartment
post
Move multiple storage compartments into another compartment
post
Get a storage layer's samples
get
Find a free sample location in or below a storage layer
get
Delete multiple storage compartments
del
Get a storage unit or equipment's meta fields
get
Create a new equipment or storage unit meta field
post
Create multiple new equipment or storage unit meta fields
post
Delete multiple meta fields in bulk
del
Update multiple meta fields in bulk
patch
Get an equipment or storage unit meta field by id
get
Delete an equipment meta field
del
Update an equipment or storage unit meta field properties
patch
Get a storage unit or equipment's managers
get
Add a manager to a storage unit or equipment
put
Add multiple managers to a storage unit or equipment
put
Remove multiple managers from a storage unit or equipment
del
Add multiple managers by user IDs to the existing managers for multiple equipment
post
Replace the managers on multiple equipment
post
Remove a manager from a storage unit or equipment
del
Remove multiple managers by user IDs from multiple equipment
del
Get an equipment's validations
get
Create a new storage unit or equipment validation
post
Create new equipment validations
post
Get an equipment validation by id
get
Delete an equipment validation
del
Update an equipment validation
patch
Get all reservations of a storage/equipment compartment
get
Create a new storage/equipment compartment reservation
post
Get a storage/equipment compartment reservation by id
get
Delete a storage/equipment compartment reservation
del
Update a storage/equipment compartment reservation
patch
Supplies
List catalog items
get
List orders
get
Create an order for a sample
post
Update an order
put
System
Get the current eLab version
get
List deduplicated controller capabilities
get
List supported system timezones
get
Check whether this installation is a custom deployment
get
Task Management
List tasks for the current user
get
Create a task
post
Get a single task
get
Delete a task
del
Update a task
patch
Link a sample to a task
post
List samples linked to a task
get
Link an experiment to a task
post
List experiments linked to a task
get
Link a protocol to a task
post
List protocols linked to a task
get
Link equipment to a task
post
List equipment linked to a task
get
Delete multiple tasks
del
Update the status of multiple tasks
patch
User
Get a current user setting
get
Get the current user settings
get
Create a current user setting
post
Update a current user setting
put
Delete a user setting for the logged in user
del
Get a user setting by user ID
get
Update a user setting by user ID
put
Delete a user setting by user ID
del
Get user settings by user ID
get
Create a user setting by user ID
post
Reset MFA settings by user ID
post
Get the current user info
get
Get the profile of a user
get
Update user information
patch
Get the current user setting
get
Set the current user setting
post
Get the current user plugin setting
get
Set the current user plugin setting
post
Find users by email address (requires 'read' scope)
get
Get the information of a user
get
View
List views
get
Create a view
post
Get a view
get
Update a view
put
Delete a view
del
Authentication
Authentication
Copy Page
Updated 10 months ago
Delete a view
Did this page help you?
Yes
No
Updated 10 months ago
Delete a view
Did this page help you?
Yes
No
