Document Server
Plugins and Macros
Document Builder
Community Server
Hosted Solution
Get started
Get Started
Basic concepts
Passing authentication
Portal api methods
authentication
Get token
Get token
Register user on personal
Save mobile phone
Send sms code
calendar
Calendar by ID
Calendars and subscriptions
Create calendar
Create calendar
Create new event
Create new event
Create new event
Create new event
Delete calendar
Delete event
Delete event series
Delete task
Get access parameters
Get CalDav link
Get default access
Get iCal feed
Get iCal link
Import iCal
Import iCal
Import iCal
Returns the event in ics format from history
Returns the event in ics format from history
Subscription list
Unsubscribe from event
Update calendar
Update calendar user view
Update event
Update event
Update todo
capabilities
Get portal capabilities
community
Birthday
Subscribe/unsubscribe on birthday
Blogs
Add blog comment
Add comment
All posts
By tag
Create post
Delete post
Get comment preview
Get comments
My posts
Remove comment
Search posts
Specific post
Tags
Update blog comment
Update post
User posts
Bookmarks
Add bookmark
Add bookmark comment
Add comment
Added by me
All bookmarks
All tags
By tag
Get bookmarks by ID
Get comment preview
Get comments
My favorite
Recently added
Remove comment
Removes bookmark
Removes bookmark from favourite
Search
Top of day
Top of month
Top of week
Top of year
Update bookmark comment
Events
Add comment
Add event comment
All events
Create event
Get comment preview
Get comments
My events
Remove comment
Search
Specific event
Subscribe/unsubscribe on comments
Update comment
Update event
Vote for event
Forums
Add post to topic
Add thread to category
Add topic to thread
Delete category
Delete post
Delete thread
Delete topic
Forum list
Last updated topics
Posts
Search
Thread topics
Update post in topic
Update topic in thread
Wiki
Add wiki comment
All comments
Create comment
Create page
Delete file
Delete page
File
Get comment preview
History
Page
Pages
Remove comment
Search
Search
Update comment
Update page
Upload files
Get preview
crm
Cases
Add case contact
Close case
Create case
Delete case
Delete case contact
Delete case group
Delete case group
Get all case contacts
Get case by ID
Get case list
Resume case
Set case access rights
Set case access rights
Set rights to case
Update case
Common
Add currency rates
Change currency
Change web form key
Create currency rate
Delete currency rate
Get currency list
Get currency rate
Get currency rate
Get currency rates list
Get the result of convertation
Get the summary table
Set currency rates
Set tenant settings
Update currency rate
Contacts
Add contact info
Add contact opportunity
Add contact opportunity
Add person to company
Change contact photo
Change contact photo
Create company
Create contact status
Create contact type
Create person
Delete contact
Delete contact avatar
Delete contact group
Delete contact info
Delete contact status
Delete contact type
Delete person from company
Delete the list of all contacts
Find twitter profiles
Get all categories
Get all contact info types
Get all contact statuses
Get all contact types
Get company linked persons list
Get contact by ID
Get contact info
Get contact information
Get contact information by type
Get contact list
Get contact SM images
Get contact SM images by networks
Get contact status
Get contact type
Get contacts by contact info
Get contacts by project ID
Get user tweets
Link contact list with project
Link contact with project
Merge contacts
Quick company list creation
Quick person list creation
Remove contact from project
Set contact access rights
Set contact access rights
Set contact access rights
Update company
Update company and participants status
Update contact info
Update contact status
Update contact status color
Update contact statuses order
Update contact type
Update contact types order
Update CRM contact status settings
Update CRM contact tag settings
Update CRM write mail to history settings
Update person
Update person, related company and participants status
Update status in contact by id
Upload user avatar from social network
Files
Associate file with entity
Create txt
Delete file
Get file list
Get root folder ID
Upload file
History
Create event
Create history category
Delete event and related files
Delete history category
Get all history categories
Get event list
Update history categories order
Update history category
Update history category icon
Invoices
Check invoice existence by number
Check invoice pdf file
Create invoice
Create invoice item
Create invoice line
Create invoice tax
Delete invoice
Delete invoice group
Delete invoice item
Delete Invoice item group
Delete invoice line
Delete invoice tax
Get default invoice settings
Get entity invoices
Get invoice by ID
Get invoice by number
Get invoice item by ID
Get invoice item list
Get invoice json data
Get invoice list
Get invoice pdf file
Get invoice sample
Get invoice taxes list
Save default invoice number
Save default invoice terms
Update invoice
Update invoice group status
Update invoice item
Update invoice line
Update invoice tax
Opportunities
Add opportunity contact
Create opportunity
Create opportunity stage
Delete opportunity
Delete opportunity contact
Delete opportunity group
Delete opportunity group
Delete opportunity stage
Get all opportunity contacts
Get all opportunity stages
Get opportunity by ID
Get opportunity list
Get opportunity list
Get opportunity stage
Set opportunity access rights
Set opportunity access rights
Set rights to opportunity
Update opportunity
Update opportunity stage
Update opportunity stage
Update opportunity stage color
Update opportunity stages order
Organisation
Get organisation logo
Save organisation company address
Save organisation company name
Save organisation logo
Reports
Check report data
Delete report file
Generate report
Get report files
Get report generation state
Terminate report generation
Tags
Add tag
Add tag
Add tag group to entity
Add tag to case group
Add tag to contact group
Add tag to opportunity group
Create tag
Delete tag
Delete tag
Delete unused tags
Get all contact tags
Get entity tags
Get tags for entity type
Remove tag
Tasks
Close task
Create task
Create task category
Delete task
Delete task category
Get all task categories
Get task by ID
Get task category
Get task list
Resume task
Update task
Update task categories order
Update task category
Update task category icon
User fields
Create user field
Delete user field
Get user field list
Get user field values
Set user field value
Update custom fields order
Updates the selected user field
Voip
Add operators
Answer call
Buy number
Delete number
Delete operator
Delete uploaded file
Get available phone numbers
Get call
Get calls
Get current number
Get existing phone numbers
Get missed calls
Get number
Get operators
Get token
Get unlinked phone numbers
Get uploaded files uri
Get voip settings
Link number
Make call
Reditect call
Reject call
Save call
Save price
Update operator
Update settings
Update settings
feed
Get feed
Get fresh news count
Read
files
File Creation
Create file
Create file
Create html
Create html in 'Common'
Create html in 'My'
Create txt
Create txt in 'Common'
Create txt in 'My'
File operations
Clear recycle bin
Convert
Convert
Copy to folder
Delete files and folders
Finish all
Finish file operations
Get file operations list
Mark as read
Move or copy batch check
Move to folder
Files
Change history
Delete file
File information
File versions
Generate shared link
Open edit
Save editing
Start edit
Track edit file
Update file info
Folders
Common folder
Delete folder
Folder by ID
Folder information
Get folder path
My folder
New folder
Projects folder
Rename folder
Shared folder
Trash folder
Sharing
File sharing
Folder sharing
Remove group sharing rights
Share file
Share folder
Third-Party Integration
Get third party folder
Get third party list
Remove third party account
Save third party account
Uploads
Chunked upload
Insert file
Insert file to common
Insert file to my
Upload to Common
Upload to folder
Upload to My
Check doc service url
Search
Store original
Update if exist
group
Add group users
Add new group
All groups
Delete group
Move group users
Remove group users
Set group manager
Set group users
Specific group
Update existing group
User groups
mail
Accounts
Create account with custom mail servers.
Create new account by email and password
Create OAuth account
Delete account
Get account by email
Get default account settings
Get mailboxes, aliases and groups list
Set account state
Set account state
Set default account
Update account
Update OAuth account
Update user activity
Alerts
Delete alert by ID
Get alerts list
Contacts
Create mail contact
Get contact list for auto complete
Get crm linked entities
Gets filtered contacts
Gets filtered contacts
Remove mail contact
Update mail contact
Conversations
Add tag to conversations
Get conversation
Get prev next conversation id
Gets filtered conversations
Is conversation linked with crm
Link conversation to crm
Mark conversation as crm linked
Move conversations to folder
Remove conversations
Remove tag from conversations
Restore conversations to original folders
Set conversations status
Unmark conversation as crm linked
Filters
Check filter
Check filter
Create filter
Delete filter
Get filters list
Update filter
Folders
Create folder
Delete folder
Get folder by mail id
Get folders
Get folders
Remove all messages from folder
Update folder
HelpCenter
Get html of help center page
Images
Add trusted address
Get trusted addresses
Remove from trusted addresses
Messages
Add attachment
Add calendar body
Attach Teamlab document
Delete attachment from message
Export attachment to documents
Export attachments to documents
Export message to crm
Get filtered messages
Get message
Get message template
Get previous or next message id
Move message to folder
Remove messages
Restore messages to original folders
SaveToDraft message
Send message
Set message status
Settings
Get AlwaysDisplayImages flag
Get CacheUnreadMessages flag
Get common settings
Get EnableConversations flag
Get GoNextAfterMove flag
Set AlwaysDisplayImages flag
Set CacheUnreadMessages flag
Set EnableConversations flag
Set GoNextAfterMove flag
Tags
Create tag
Delete tag
Get tags list
Remove tag from messages
Set tag to messages
Update tag
Get all Mail running complex operations
Get Mail complex operation status
Get signature
Update autoreply
Update signature
mailserver
AddressData
Add mailbox's aliases
DnsRecords
Get free DNS records
Returns dns records
Domains
Add domain to mail server
Check domain ownership.
Get common web domain
Get tenant web domain list
Is domain name exists.
Remove domain from mail server
Mailboxes
Change mailbox password
Create mailbox
Create mailbox
Get mailboxes list
Is server mailbox address exists
Is server mailbox address valid
Remove mailbox from mail server
Remove mailbox's aliases
Update mailbox
MailGroup
Add group's addresses
Create mail group address
Get mail group list
Remove group address from mail server
Remove group's address
Notifications
Create notification address
Remove mailbox from mail server
Servers
Get mail server
Get mail server
people
Reassign user data
Get reassign progress
Start reassign
Terminate reassign
Remove user data
Get remove progress
Start remove
Terminate remove
Add new import user
Add new user
All profiles
Create user photo thumbnails
Delete user
Delete user contacts
Delete user photo
Delete users
Get by status
Get status
Get user photoes
Join to affiliate programm
My profile
Search users
Send activation email
Send delete instructions
Set user contacts
Specific profile
Specific profile
Update user
Update user contacts
Update user photo
User search
User search by extended filter
User search by extended filter
User search by filter
User status change
User type change
portal
Backup
Create backup schedule
Delete backup
Delete backup history
Delete backup schedule
Get backup history
Get backup progress
Get backup schedule
Get restore progress
Start backup
Start backup restore
Quota
Quota of the current portal
Quota of the current portal
Tariff of the current portal
Used space of the current portal
Users
Returns invitational link to the portal
User with specified userID
Users count of the current portal
Check search available
Current portal
Get search settings
Reindex
Set search settings
project
Comments
Add message comment
Add project comment
Add task comment
Get comment
Get preview
Message comments
Remove comment
Task comments
Update comment
Contacts
Add project contact
Delete project contact
Get projects for contact
Discussions
Add message
Check subscription to discussion action
Delete message
Get message by filter
Get preview
Get subscribers
Latest messages
Message
Messages
Subscribe to message action
Update message
Update message status
Files
Detach file from message
Detach file from task
Entity files
Get task files
Message files
Upload file to message
Upload file to task
Import
Add importing URL to queue
Get import status
Get projects for import
Milestones
Delete milestone
Delete milestones
Get milestone
Get milestone tasks
Milestones by filter
Milestones by full date
Milestones by month
Overdue milestones
Upcoming milestones
Update milestone
Update milestone status
Projects
Add milestone
Create project
Delete project
Followed projects
Following/Unfollowing project
Get milestones by project ID
Get milestones by project ID and milestone status
Get total project time
Participated projects
Project by ID
Project by status
Project files by project ID
Project time spent
Projects
Projects
Search all projects
Search project
Update project
Update project status
Update project tags
Update project tags
Report
Create report template
Delete report template
Get report template
Update report template
Tags
Project by tag
Project tags
Tag
Tags by tag name
Tasks
Add link
Add task
Add task
Check subscription to task action
Copy subtask
Copy task
Create subtask
Delete subtask
Delete task
Delete tasks
Get task
Get task by filter
My tasks
My tasks
My tasks by status
Notify task responsible
Remove link
Subscribe to task action
Tasks
Tasks with status
Update subtask
Update subtask status
Update Task
Update task milestone
Update task status
Update tasks milestone
Update tasks status
Team
Add to team
Project team
Project team
Project team
Remove from team
Set team security
Updates project team
Template
Create template
Delete template
Template by ID
Templates
Update template
Time
Add task time
Delete time spents
Get time spent
Get time spent by filter
Get total time spent by tilter
Update task time
Updates the time status of payment
Check report data
Create project
Get generated reports
Get report status
Get settings
Remove generated report
Terminate report
Update project
Update settings
settings
Check Recalculate Quota Task
Create custom navigation item
Delete custom navigation item
Get all backup storages
Get all cdn storages
Get all storages
Get custom navigation item
Get custom navigation item sample
Get custom navigation items
Get default SSO settings
Get ip restrictions
Get LDAP AutoSync Cron expression
Get LDAP default settings
Get LDAP settings
Get LDAP sync process status
Get product administrators
Get security settings
Get SMTP settings
Get SMTP test process status
Get space usage statistics
Get SSO settings
Get SSO settings constants
Get storage progress
Get visit statistics
Get web item security info
Is product administrator
Password settings
Portal logo
Portal settings
Recalculate Quota
Reset cdn to default
Reset SMTP settings
Reset SSO settings
Reset storage to default
Save ip restrictions
Save LDAP settings
Save LDAP settings
Save SMTP settings
Save SSO settings
Set access
Set product administrator
Set security settings
Sets LDAP AutoSync Cron expression
Space usage
Sync LDAP
Sync LDAP
Test SMTP settings
Tfa app new app
Tfa app request new codes
Tfa settings
Update cdn
Update email activation settings
Update ip restrictions settings
Update storage
Update tips settings
Update tips subscription
Help
F.A.Q.
Filtering
Batching
files
Provides access to documents
Name
Resource
Description
Check doc service url
PUT
api/2.0/files/docservice
Checking document service location
Search
GET
api/2.0/files/@search/{query}
Store original
PUT
api/2.0/files/storeoriginal
Update if exist
PUT
api/2.0/files/updateifexist
Home site
For integrators
Document Builder
Server Forum
SaaS Forum
Help Center
Legal notice
© Ascensio System SIA 2019. All rights reserved