Jump to Content
Home
Guides
Recipes
API Reference
v2025-04-21
Log In
API Reference
Log In
v2025-04-21
Home
Guides
Recipes
API Reference
v2023-09-18
All
Pages
Start typing to search…
JUMP TO
Overview
Get Started
Changelogs
v2025-04-21
v2024-05-20
v2023-09-18
API Concepts
How to Authenticate
Breaking Changes
Versioning
Pagination
Rate Limiting
Operations1 REST API
User
Get a user by id
get
Update a user
patch
List users
get
Create a user
post
Delete user qualification
del
Upsert qualifications to user
post
Push document into user view
post
Update the role of an user
put
User role
List roles
get
Create a role
post
List permissions
get
Add permission to a role
put
Report
Download PDF feedback
get
Download video feedback
get
List reports
get
Create a report
post
Update an interaction value
put
List class characteristics of a report
get
List interaction values of a report
get
Get a report by id
get
Update a report
patch
Get image feedback file by id
get
Get media feedbacks by report id
get
Create a sharable link for a report
post
Create a job to generate pdf report
post
Get generated pdf report job information
get
Download PDF
get
Export report data
get
Download CSV
get
Download XLSX
get
Document
Create a document
post
List documents
get
Update a document
patch
Get a document by id
get
Get steps and nested documents of a document
get
Get list of all the steps from a document and their nested documents
get
Duplicate document
post
Add class characteristic to the document
put
Remove class characteristic from the document
del
Change document versioning
post
Delete sub-module of document
del
Add sub-module to a document
put
Add qr-code to the document
put
Export document data
get
Add document translation
post
Add required qualifications
post
Add granted qualifications
post
Delete required qualification
del
Delete granted qualification
del
Base document
Get access controls for a base document
get
Create access controls for a base document
post
Delete an access control element
del
Task
List tasks
get
Create a task
post
Update a task
patch
Create a task message
post
Create access controls for a task
post
Delete access control for a task
del
Archive or unarchive tasks
patch
Group
Create a group
post
Archive a group
patch
Delete a group
del
List groups
get
Update a group
patch
Get group by id
get
Add or remove users to a group
post
Order
List orders
get
Create an order
post
Update an order
patch
Replace class characteristics of an order
put
Duplicate order
post
Instantiate an order
post
Attach pdf to an order
post
Create access controls for an order
post
Delete access control for an order
del
Add documents to an order
post
Delete document from an order
del
Update a document assignment
patch
Detach reports from an order
post
Update assignees for order reports
patch
Classes
List classes
get
Create a class
post
Get class by id
get
Class characteristics
List class characteristics of a class
get
Create a class characteristic
post
Interaction
Get an interaction by id
get
Media
List PDFs from global media
get
Material
List global materials
get
Create global material
post
Update global material
patch
Add class characteristic to global material
put
Delete class characteristic from global material
del
Upload image for global material
put
QR-code
Create a qr-code
post
Qualification
Get qualifications list
get
Connector
Execute order connector
post
Rule
List rules (order templates)
get
Powered by
v2023-09-18
Ask AI
