Navigation Menu
DocSpace
JavaScript SDK
Plugins SDK
OAuth API
API Backend
For Hosting Providers
Docs
Docs API
Office API
Plugin and Macros
Document Builder
Desktop Editors
Workspace
API Backend
For Hosting Providers
Type
/
to search
Get Started
Basic concepts
Passing authentication
Usage API
authentication
Authenticate a user
Authenticate a user by code
Send SMS code
Set a mobile phone
calendar
Calendars and subscriptions
Create a calendar
Create a calendar by the iCal link
Delete a calendar
Delete a project calendar
Get a calendar by ID
Get access parameters
Get CalDav link
Get calendar events
Get calendars
Get default access parameters
Get iCal link
Get subscriptions
Get the iCal feed
Get the UTC offset
Update a calendar
Update the calendar view
Events
Add the iCal event
Create a new event in the default calendar
Create a new event in the selected calendar
Create a new iCal event
Delete the CalDav event
Delete the event series
Delete the specified event(s) from event series
Get the iCal event by ID
Get the iCal event by UID
Import the events from the iCal string
Import the iCal events to the default calendar
Import the iCal events to the specified calendar
Unsubscribe from the event
Update an event
Update the CalDav event
Update the iCal event
Tasks
Create a new task
Delete a task
Refresh CalDav calendar
Update a task
capabilities
Get portal capabilities
community
Blogs
Add a blog comment
Add a post comment
Create a post
Delete a post
Get a comment preview
Get a post
Get my posts
Get post comments
Get posts
Get posts by tag
Get tags
Get user posts
Remove a comment
Search posts
Update a blog comment
Update a post
Bookmarks
Add a bookmark
Add a bookmark comment by bookmark ID
Add a bookmark comment by entity ID
Get a bookmark
Get a comment preview
Get bookmark comments
Get bookmarks
Get bookmarks by tag
Get my bookmarks
Get my favorite bookmarks
Get recent bookmarks
Get tags
Get top of the day bookmarks
Get top of the month bookmarks
Get top of the week bookmarks
Get top of the year bookmarks
Remove a bookmark
Remove a bookmark from favorites
Remove a comment
Search bookmarks
Update a bookmark comment
Events
Add an event comment by entity ID
Add an event comment by feed ID
Comment subscription
Create an event
Delete an event
Get a comment preview
Get an event
Get event comments
Get events
Get my events
Remove a comment
Search events
Update a comment
Update an event
Vote for an option
Forums
Add a post to a topic
Add a thread to a category
Add a topic to a thread
Delete a category
Delete a post
Delete a thread
Delete a topic
Get forums
Get recently updated topics
Get thread topics
Get topic posts
Search topics
Update a topic
Update a topic post
Get preview
Wiki
Add an entity comment
Create a page
Create a page comment
Delete a file
Delete a page
Get a comment preview
Get a file
Get a page
Get page comments
Get pages
Get the page history
Remove a comment
Search pages by content
Search pages by name
Update a comment
Update a page
Upload files
crm
Cases
Add a case contact
Close a case
Create a case
Delete a case
Delete a case contact
Delete cases by IDs
Delete cases by parameters
Get a case by ID
Get case contacts
Get cases
Reopen a case
Set access rights to the case
Set access rights to the cases by IDs
Set access rights to the cases by parameters
Update a case
Contacts
Add a contact opportunity
Add a person to the company
Add contact address information
Add contact information
Change a contact photo
Change a contact photo by URL
Create a company
Create a contact status
Create a contact type
Create a person
Create companies
Create persons
Delete a contact
Delete a contact avatar
Delete a contact opportunity
Delete a contact status
Delete a contact type
Delete a person from the company
Delete contact information
Delete contacts by IDs
Delete contacts by parameters
Get a contact by ID
Get a contact status
Get a contact type
Get company persons
Get contact access rights
Get contact categories by information type
Get contact information
Get contact information by ID
Get contact information by its type
Get contact information types
Get contact statuses
Get contact types
Get contacts by contact information
Get contacts by project ID
Get filtered contacts
Link a contact to the project
Link contacts to the project
Merge contacts
Remove a contact from the project
Set access rights to the contacts by IDs
Set access rights to the contacts by parameters
Set contact access rights
Set the tenant settings
Update a company
Update a company status
Update a contact status
Update a contact status by ID
Update a contact status color
Update a contact type
Update a person
Update a person and his company status
Update contact address information
Update contact information
Update the contact status setting
Update the order of contact statuses
Update the order of contact types
Update the setting for adding tags to the contact
Update the setting for writing mails to the history
Update the web form key
Currencies
Add currency rates
Convert a currency
Create a currency rate
Delete a currency rate
Get a currency rate by currencies
Get a currency rate by ID
Get available currencies
Get currency rates
Get currency summary table
Set currency rates
Update a currency
Update a currency rate
Custom fields
Create a custom field
Delete a custom field
Get custom fields
Get entity custom fields
Set an entity custom field
Update a custom field
Update the order of custom fields
Files
Attach files to the entity
Create a text file
Delete a file
Get entity files
Get root folder ID
Upload a file
History
Create a history category
Create an event
Delete a history category
Delete an event
Get filtered events
Get history categories
Update a history category
Update a history category icon
Update the order of history categories
Invoices
Check invoice existence by number
Create an invoice
Create an invoice item
Create an invoice line
Create an invoice tax
Delete an invoice
Delete an invoice item
Delete an invoice line
Delete an invoice tax
Delete invoice items
Delete invoices
Get an invoice by ID
Get an invoice by number
Get an invoice item by ID
Get an invoice sample
Get entity invoices
Get filtered invoice items
Get invoice converter data
Get invoice taxes
Get invoices
Get the default invoice settings
Get the invoice JSON data
Get the invoice pdf file
Save the invoice number default settings
Save the invoice terms default settings
Update an invoice
Update an invoice group status
Update an invoice item
Update an invoice line
Update an invoice tax
Opportunities
Add an opportunity contact
Create an opportunity
Create an opportunity stage
Delete an opportunity
Delete an opportunity contact
Delete an opportunity stage
Delete filtered opportunities
Delete opportunities by IDs
Get an opportunity
Get an opportunity stage
Get contact opportunities
Get filtered opportunities
Get opportunity contacts
Get opportunity stages
Set access rights to the filtered opportunities
Set access rights to the opportunities by IDs
Set opportunity access rights
Update an opportunity
Update an opportunity stage
Update an opportunity stage by ID
Update an opportunity stage color
Update the order of opportunity stages
Organization
Get an organization logo
Update a company address
Update a company name
Update the organization logo setting
Reports
Check report data
Delete a report file
Generate a report
Get report files
Get the report generation status
Terminate the report generation
Tags
Add a tag to cases
Add a tag to contacts
Add a tag to opportunities
Add a tag to the entities
Add a tag to the entity
Add a tag to the entity and related contacts
Create a tag
Delete a tag from entities
Delete a tag from the entity and related contacts
Delete an entity tag
Delete unused tags
Get contact tags
Get entity tags
Get entity type tags
Tasks
Close a task
Create a task
Create a task category
Delete a task
Delete a task category
Get a task category
Get task by ID
Get task categories
Get tasks
Reopen a task
Update a task
Update a task category
Update a task category icon
Update the order of task categories
VoIP
Add operators
Answer a call
Buy a phone number
Delete a phone number
Delete an operator
Delete an uploaded file
Get a call
Get a phone number
Get a phone number token
Get all phone numbers
Get calls
Get filtered phone numbers
Get missed calls
Get operators
Get the current phone number
Get the links to the uploaded files
Get the VoIP settings
Get unlinked phone numbers
Link a phone number
Make a call
Redirect a call
Reject a call
Save a call
Save a call price
Update an operator
Update the phone number settings
Update the VoIP settings
feed
Count fresh feeds
Get feeds
Read feeds
files
Files
Add template files
Change version history
Copy a file
Create a file
Create a file in the "My documents" section
Delete a file
Delete template files
Get file download link
Get file properties
Get file versions
Get the file information
Open a file
Save file edits
Save file properties to a file
Save file properties to files
Start file editing
Track file editing
Update a file
Update file content
Folders
Create a folder
Create a folder structure
Delete a folder
Get a folder by ID
Get filtered sections
Get the "Common" section
Get the "Favorites" section
Get the "In projects" section
Get the "My documents" section
Get the "Recent" section
Get the "Shared with me" section
Get the "Templates" section
Get the "Trash" section
Get the folder information
Get the folder path
Insert a file
Insert a file to the "Common" section
Insert a file to the "My documents" section
Rename a folder
Upload a file
Upload a file to the "Common" section
Upload a file to the "My documents" section
Operations
Add favorite files and folders
Bulk download
Check files and folders for conflicts
Chunked upload
Copy to a folder
Delete favorite files and folders
Delete files and folders
Empty the "Trash" folder
Finish active operations
Get active operations
Get conversion status
Mark as read
Move to a folder
Search for files and folders
Start file conversion
Settings
Change the archive format
Change the default access rights
Check the document service URL
Display the "Favorites" folder
Display the "Recent" folder
Display the "Templates" folder
Get the auto-clearing setting properties
Get the document service URL
Store original formats
Update a file version if it exists
Update the trash bin auto-clearing setting
Sharing
Get a token for a password-protected external link
Get the shared file information
Get the shared folder information
Get the shared link
Get the shared link template
Remove sharing rights
Set a cookie for a password-protected external link
Share a file
Share a folder
Third-party integration
Get common third-party services
Get providers
Get third-party services
Remove a third-party account
Save a third-party account
group
Add a new group
Add group members
Delete a group
Get a group
Get groups
Get groups by a group name
Get user groups
Move group members
Remove group members
Replace group members
Set a group manager
Update a group
mail
Accounts
Create an account by custom mail servers
Create an account by email and password
Create an OAuth account
Delete an account
Get an account by email
Get the default account settings
Get user accounts
Set a folder account email
Set the account status
Set the default account
Update an account
Update an OAuth account
Update the user activity status
Alerts
Delete an alert
Get alerts
Attachments
Add a calendar
Add an attachment
Attach a document
Delete an attachment
Download attachments
Export an attachment
Export message attachments
Autoreply
Update an autoreply
Contacts
Create a mail contact
Get contacts by contact information
Get contacts by search query
Get the linked CRM entities
Remove mail contacts
Search contacts
Update a mail contact
Conversations
Add a tag to the conversations
Check a conversation CRM status
Get a conversation
Get filtered conversations
Get the previous or next conversation ID
Link a conversation to CRM
Mark a conversation as CRM linked
Move conversations
Remove a tag from the conversations
Remove conversations
Restore conversations
Set a conversation status
Unmark a conversation as CRM linked
Filters
Apply a filter
Check filter results
Create a filter
Delete a filter
Get filters
Update a filter
Folders
Create a folder
Delete a folder
Get a folder by mail ID
Get the default folders
Get the user folders
Remove folder messages
Update a folder
Help Center
Get the Help Center page HTML
Images
Add the trusted image address
Get trusted image addresses
Remove the trusted image address
Messages
Export a message to CRM
Get a message
Get a message template
Get filtered messages
Get the previous or next message ID
Move messages to the folder
Reassign drafts/templates
Remove messages
Restore messages
Save a draft message
Save a template message
Send a message
Send a message quickly
Set a message status
Operations
Get a mail operation status
Get running mail operations
Settings
Get the "Always display external images" flag
Get the "Cache unread messages" flag
Get the "Enable Conversations" flag
Get the "Go next after move" flag
Get the "Replace message body" flag
Get the mail common settings
Set the "Always display external images" flag
Set the "Cache unread messages" flag
Set the "Enable Conversations" flag
Set the "Go next after move" flag
Set the "Replace message body" flag
Signature
Get a signature
Update a signature
Tags
Create a tag
Delete a tag
Get tags
Remove a tag from the messages
Set a tag to the messages
Update a tag
mailserver
Domains
Add a domain to the mail server
Check the domain name existence
Check the domain ownership
Get common web domain
Get DNS records by domain ID
Get web domains
Remove a domain from the mail server
Mail groups
Add an address to the mail group
Create a mail group
Get mail groups
Remove a mail group
Remove an address from the mail group
Mailboxes
Add a mailbox alias
Change a mailbox password
Check the mailbox address correctness
Check the mailbox address existence
Create a mailbox
Create a mailbox with your own domain
Get mailboxes
Remove a mailbox
Remove a mailbox alias
Update a mailbox
Notifications
Create a notification address
Remove a notification address
Servers
Get or create free DNS records
Get the mail server
Get the mail server information
migration
Cancel migration
Complete migration
Get migration logs
Get migration status
Get migration temporary folder
Get migrations
Get migrator information
Initialize migration
Start migration
people
Birthday
Birthday subscription
Contacts
Delete user contacts
Set user contacts
Update user contacts
Email
Change a user email
Password
Change a user password
Photos
Create a photo thumbnail
Delete a user photo
Get a user photo
Update a user photo
Profiles
Add a user
Delete a user
Delete users
Get a profile by user email
Get a profile by user name
Get my profile
Get profiles
Import users
Resend an activation email
Send the deletion instructions
Update a user
Search
Search user profiles
Search users
Search users and their information by extended filter
Search users by extended filter
Search users by status filter
User data
Get the deletion progress
Get the reassignment progress
Start the data deletion
Start the data reassignment
Terminate the data deletion
Terminate the data reassignment
User status
Change a user status
Get a user status
Get profiles by status
User type
Change a user type
portal
Backup
Create the backup schedule
Delete the backup
Delete the backup history
Delete the backup schedule
Get the backup history
Get the backup progress
Get the backup schedule
Get the restoring progress
Start the backup
Start the restoring process
Quota
Get a portal quota
Get a portal tariff
Get the recommended quota
Get the used portal space
Search
Check the search availability
Get the search settings
Reindex a page
Set the search settings
Settings
Get the current portal
Users
Get a number of portal users
Get a user by ID
Get an invitation link
project
Comments
Get a comment
Get a comment preview
Remove a comment
Update a comment
Discussions
Add a message
Add a message comment
Check the discussion subscription
Delete a message
Get a message
Get a message preview
Get discussion subscribers
Get filtered messages
Get message comments
Get messages
Get recent messages
Subscribe to discussion
Update a message
Update a message status
Files
Detach a file from a message
Detach a file from a task
Get entity files
Get message files
Get project files
Get task files
Upload files to the message
Upload files to the task
Milestones
Add a milestone
Delete a milestone
Delete milestones
Get a milestone
Get filtered milestones
Get milestone tasks
Get milestones by deadline
Get milestones by deadline month
Get milestones by milestone status
Get milestones by project ID
Get overdue milestones
Get recent milestones
Get upcoming milestones
Update a milestone
Update a milestone status
Projects
Add a project comment
Add a project contact
Create a project
Create a project with team security
Delete a project
Delete a project contact
Delete projects
Get a project by ID
Get contact projects
Get filtered projects
Get followed projects
Get my projects
Get projects
Get projects by status
Project subscription
Search in a project
Search projects
Update a project
Update a project status
Update a project with team security
Reports
Check the report data
Create a report template
Delete a report template
Get a report status
Get a report template
Get generated reports
Remove the generated report
Terminate the reporting process
Update a report template
Settings
Get the project settings
Update the project settings
Tags
Create a tag
Get project tags
Get projects by a tag
Get tags by a tag name
Update a project tag
Update project tags
Tasks
Add a link between tasks
Add a task
Add a task by message ID
Add a task comment
Check the task subscription
Copy a subtask
Copy a task
Create a subtask
Create a task status
Delete a subtask
Delete a task
Delete a task status
Delete tasks
Get a task
Get filtered tasks
Get my tasks
Get my tasks by status
Get my tasks by status
Get task comments
Get task statuses
Get tasks
Get tasks by status
Move a subtask
Notify the task responsible
Remove a link between tasks
Subscribe to a task
Update a milestone of tasks
Update a status of tasks
Update a subtask
Update a subtask status
Update a task
Update a task milestone
Update a task status
Update a task status by task ID
Update task statuses
Teams
Add a user to the team
Get a project team
Get current and excluded team members
Get team members of projects
Remove a user from the team
Set team security
Update a project team
Templates
Create a template
Delete a template
Get a template
Get templates
Update a template
Time
Add task time
Delete task time
Get filtered task time
Get filtered total task time
Get project time
Get task time
Get total project time
Update task time
Update the time payment status
security
Active connections
Get active connections
Log out and change password
Log out for the user by ID
Log out from all connections
Log out from the connection
Audit trail data
Generate the audit trail report
Get audit trail data
Get audit trail mappers
Get audit trail types
Get filtered audit trail data
Get the audit trail settings
Set the audit trail settings
Impersonation
Check user impersonation
Get impersonation settings
Impersonate a user
Log out impersonated user
Update impersonation settings
Login history
Generate the login history report
Get filtered login events
Get login history
Update login settings
settings
Common settings
Close the admin helper notification
Close the welcome pop-up notification
Get a portal logo
Get the portal settings
Get the socket settings
Update the email activation settings
Custom navigation
Add a custom navigation item
Delete a custom navigation item
Get a custom navigation item by ID
Get a custom navigation item sample
Get the custom navigation items
Firebase
Saves the Documents Firebase device token
Saves the Projects Firebase device token
IP restrictions
Get the IP portal restrictions
Save the IP restrictions
Update the IP restrictions
LDAP
Get the LDAP cron expression
Get the LDAP default settings
Get the LDAP settings
Get the LDAP synchronization process status
Save the LDAP settings
Set the LDAP cron expression
Synchronize with LDAP server
Test the LDAP saving process
Test the LDAP synchronization
Quota
Check quota recalculation
Check users quota recalculating
Get the space usage
Recalculate quota
Recalculates quota
Security
Check the product administrator
Get the module availability
Get the password settings
Get the product administrators
Get the security settings
Set the module security settings
Set the password settings
Set the product administrator
Set the security settings to modules
SMTP
Get the SMTP settings
Get the SMTP test process status
Reset the SMTP settings
Save the SMTP settings
Test the SMTP settings
SSO
Get the default SSO settings
Get the SSO settings
Get the SSO settings constants
Reset the SSO settings
Save the SSO settings
Statistics
Get the space usage statistics
Get the visit statistics
Storage
Get Amazon regions
Get storages
Get the backup storages
Get the CDN storages
Get the storage progress
Reset the CDN storage settings
Reset the storage settings
Update a storage
Update the CDN storage
Telegram
Check the Telegram connection
Unlink Telegram
Tenant quota
Set tenant quota settings
TFA settings
Get TFA settings
Request the TFA codes
Unlink the TFA application
Update the TFA settings
Tips
Update the tip settings
Update the tip subscription
User quota
Change a user quota limit
Save user quota limit
More Information
FAQ
Filtering
Batching
Workspace
API Backend
Usage API
people
Search
Search
Search user profiles
Search users
Search users and their information by extended filter
Search users by extended filter
Search users by status filter
Results
Get Help
If you have any questions about ONLYOFFICE Workspace, try the
FAQ
section first.
You can request a feature or report a bug by posting an issue on
GitHub
.
You can also ask our developers on
ONLYOFFICE forum
(registration required).