The WApi api can be used through various protocols, in a synchronous or a asynchronous way.
Http request usage:
The usage mode is synchronous.
The WApi web service can be accessed using that url: https://api.wimi.pro.
WApi has to be called in POST mode. The body of the request contains the WApi input message (json format).
The body of the response contains the WApi response (json format).
The HTTP status code returned by the WApi is always 200. Responses errors must be extracted from the response message (body of the response)
The request and response messages are based on the same format.
Login request example:
{ "header": { "target": "auth.user.login", "identification": { "account_name": "myaccount" }, "auth": { "login": "firstname.lastname@domain.com", "password": "mypassword" }, "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "a key that can be used to map the response with the request in async mode" }, "body": { "data": null } }
Login response example:
{ "header": { "target": "auth.user.login.info", "identification": { "account_name": "myaccount" }, "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "a key that can be used to map the response with the request in async mode", "token": "MTU0MDAw:MOB--202545756bd71499f9" }, "body": { ... } } }
So, the response target is the request target + ".info".
The "msg_key" of the response is the same as the request "msg_key".
Globally speaking, the response header is the same as the request header with some adjustments.
The Header format is generic (common to all request / responses).
The Body format is specific to each target - however the error management is generic
(string) - Used to identify the WApi function called
(optional object) - Used to provide the ids of the various objects used by the function call - the listed entries are specific to the target being called.
"identification": { "account_id": 19472, "user_id": 154031, "project_id": 131213 }
(optional object) - Used to provide user authentication
"auth": { "login": "firstname.lastname@domain.com", "password": "mypassword" }
(optional string) - Used to provide the session token (returned by auth.user.login)
(string) - Api version used
(string) - Message key also returned in the message response
(optional object) - used to provide output formatting parameters:
"output_format": { "populate_http_status_code": true }
(optional object) - used to provide special debugging parameters:
"debug": { "indent_output": true }
(optional object) - Used in the request and response WApi messages.
The format is specific to each target.
(optional object) - Only found in response WApi messages.
"error": { "id": 401, "str": "Unauthorized", "debug_msg": "account not found: myaccount", "detail_id": 1022, "detail_str": "invalid_account" }
auth.user.Login | Used to login a user and retrieve an access token |
auth.user.Logout | Used to logout a user |
activity.event.ClearUnreadCount | Clear the activity unread count |
activity.event.ExportAsCSV | export the list of activity events in a CSV file |
activity.event.GetList | Get a list of activity events |
activity.event.GetNextList | Ask for the next X results from events |
activity.event.GetNotifications | Get a list of activity events notified for the contexted user |
activity.event.GetUnreadCount | Get unread event count by projects |
activity.event.NewEvent | Used to generate push message |
activity.event.NewEventList | Used to generate push message |
calendar.event.AddComment | Add a comment to a calendar event |
calendar.event.AddExternalAttachment | Attach an external file to a calendar event |
calendar.event.AddExternalAttachmentFromTemplate | Attach an external file to a calendar event, from a template |
calendar.event.AddExternalParticipants | Add external participant for a specific event |
calendar.event.AddTag | Add a tag to a Calendar Event |
calendar.event.AddWimiAttachment | Attach a wimi file to a calendar event |
calendar.event.ChangeInviteStatus | Change Status of Agenda Event Participant. Accept / Refuse invite to an event |
calendar.event.ConversationArchive | Archive a conversation |
calendar.event.ConversationClearUnseen | Clear unseen count for conversation |
calendar.event.ConversationSetSilent | Set silent for conversation |
calendar.event.CopyEventList | |
calendar.event.Create | Create a calendar event |
calendar.event.DeleteComment | Delete a calendar event comment |
calendar.event.DownloadAttachment | Download a calendar event attachment |
calendar.event.EditComment | Edit a comment of a calendar event |
calendar.event.GenerateWOGeneralFile | create an external file to a calendar event |
calendar.event.Get | Get the details of a calendar events |
calendar.event.GetAttachmentList | get the list of files attached to a calendar event |
calendar.event.GetComments | Get teh comments of a calendar event |
calendar.event.GetDownloadInviteLink | Download the ics for a specific event |
calendar.event.GetExternalParticipants | Get external participant for a specific event |
calendar.event.GetList | Get a list of events |
calendar.event.GetListUnified | Get a list of events for unified calendars |
calendar.event.GetSubscriptionLink | Get a calendar subscription link |
calendar.event.GetUnifiedSubscriptionLink | Get calendar subscription link for unified projects |
calendar.event.LinkTag | Link a tag to a calendar event |
calendar.event.PreviewAttachment | Request attachment preview |
calendar.event.Remove | Delete a calendar event |
calendar.event.RemoveExternalAttachment | remove an external attachment from the calendar |
calendar.event.RemoveExternalParticipants | Remove external participant for a specific event |
calendar.event.RemoveRecurrenceOccurrence | Delete a recurrence occurrence |
calendar.event.RemoveTag | Remove a tag in a task |
calendar.event.RemoveWimiAttachment | remove a wimi attachment from the calendar |
calendar.event.Update | Update a calendar event - only the provided data are updated. |
calendar.event.UpdateProject | Move a calendar event from one project to another |
chat.chat.AddAttachment | Attach a file to a chat |
chat.chat.AddInternalAttachment | Attach a internal file to a chat |
chat.chat.AddMembers | Add members to a chat |
chat.chat.AddUsers | Add users to a chat |
chat.chat.CanceledTyping | Send a notification that the user canceled typing |
chat.chat.ClearUnseen | Clear unseen count for chat |
chat.chat.Create | Create a group chat |
chat.chat.CreateChannel | Create channel chat |
chat.chat.DeleteMessage | Delete a message |
chat.chat.Disable | Disable a chat for a user |
chat.chat.DownloadAttachment | Download a chat attachment |
chat.chat.EditMessage | Edit a message |
chat.chat.EditName | Edit a chat name |
chat.chat.FavoriteMessage | Favorite a message |
chat.chat.GetAttachmentList | Get attachment list |
chat.chat.GetChat | Get chat |
chat.chat.GetFavorites | Get favorite list |
chat.chat.GetLinks | Get shared links in a chat |
chat.chat.GetList | Get chat list |
chat.chat.GetMessageBeforeAfter | Search through chat messages |
chat.chat.LoadMessages | Get chat messages from offset of given message id, until limit |
chat.chat.PostMessage | Post message to chat |
chat.chat.PreviewAttachment | Request attachment preview |
chat.chat.RemoveMembers | Remove members from a chat |
chat.chat.RemoveUsers | Remove users from a chat |
chat.chat.Search | Search through chat messages |
chat.chat.SetMessageIntegrationAttachment | Set the integration attachment for a message |
chat.chat.SetSilent | Set silent for chat |
chat.chat.StartedTyping | Send a notification that the user is typing |
chat.chat.UnfavoriteMessage | Unfavorite a message |
chat.chat.UpdateGroupChatProfilePicture | |
chat.message.AddMessageReaction | Add a reaction for a message |
chat.message.DeleteMessageReaction | Delete a reaction for a message |
comment.comment.GetCommentsForItem | Get a specific user commented item |
comment.comment.GetUserCommentedItems | Get user commented items |
communication.air.CreatePersistentRoom | create a persistent room |
communication.air.GetPersistentRoom | Get persistent airtime room |
document.directory.AddComment | Add comment to a directory |
document.directory.AddLink | Add link to directory |
document.directory.AddMembersToDir | Add members to dir |
document.directory.ConversationArchive | Archive a conversation |
document.directory.ConversationClearUnseen | Clear unseen count for conversation |
document.directory.ConversationSetSilent | Set silent for conversation |
document.directory.Copy | Copy a directory elsewhere |
document.directory.CopyList | Copy a list of directory elsewhere |
document.directory.Create | Creates a directory |
document.directory.CreateDirectoryTree | Creates a directory tree when uploading a folder |
document.directory.DeleteComment | Delete a directory comment |
document.directory.DeniedList | Get the list of denied directories for a user |
document.directory.EditComment | Edit a comment of a directory |
document.directory.EditMembersAccessToDirectories | Edits members access on one or several directories |
document.directory.EditName | Edits the name of a directory |
document.directory.GetComments | Get comments of a directory |
document.directory.GetDirectoryUsers | Get list of all users having access to given directory |
document.directory.GetMembersAccess | Get users access of a dir |
document.directory.GetReadOnlyStateForUser | Get the read only state of the directory for the current user |
document.directory.LinkPathInfo | Get file path info |
document.directory.Move | Move directories to a folder |
document.directory.MoveLink | Move links from one directory to another |
document.directory.MoveToGarbageCollector | Permanently delete one or more directories |
document.directory.MoveToTrash | Delete one or more directories |
document.directory.PathInfo | Get directory path info |
document.directory.RemoveMembersFromDir | Remove members from dir |
document.directory.RemoveProperty | Remove a property from a directory |
document.directory.Restore | Restore one or more directories from trash |
document.directory.SetDirectoryDefault | Get comments of a directory |
document.directory.SetPropertyValue | Add a property to a directory |
document.entry.DirList | List folders found in a folder |
document.entry.GetProjectTree | Get flat tree for project |
document.entry.List | List the files and folders found in a folder |
document.entry.ListServiceEntries | List the service entries of a folder |
document.entry.TrashList | List the files, the link and folders found in the trash |
document.file.ActivateSharing | Activate sharing on one file |
document.file.AddComment | Add a file comment |
document.file.AddTag | Add a tag on a file |
document.file.AttachmentIntoDoc | Take an attachment from chat or task and add it to the documennt module |
document.file.CheckConflict | check a file name conflict |
document.file.CheckConflicts | Check conflicts of a specific name in a folder |
document.file.ConversationArchive | Archive a conversation |
document.file.ConversationClearUnseen | Clear unseen count for conversation |
document.file.ConversationSetSilent | Set silent for conversation |
document.file.Copy | Copy a file elsewhere |
document.file.CopyList | Copy a list of file elsewhere |
document.file.CreateFromTemplate | Create a file from a given template |
document.file.DeactivateSharing | Deactivate sharing on one file |
document.file.DeleteComment | Delete a file comment |
document.file.Download | download a file |
document.file.EditComment | Edit a file comment |
document.file.EditDescription | Edit a file description |
document.file.EditName | Edits the name of a file |
document.file.GetComments | Get the comments of a file |
document.file.GetDownloadToken | Get a download token to be used only one time. |
document.file.GetEvents | Get the historical events of a file |
document.file.GetIPTCMetadata | Get IPTC data for a file |
document.file.GetMetaDataFields | Get all metadata fields for account |
document.file.GetOnlineEditionFileToken | Get file token for editing file online using only office |
document.file.GetProperties | get the properties of a file |
document.file.GetVersions | Get a file's versions list |
document.file.GuestLink | Get guest link of a file - DEPRECATED - use ActivateSharing |
document.file.IsVersionOf | Checks if a version of a file is on the server (by md5) |
document.file.LinkTag | Link a tag to a file |
document.file.Lock | Used to lock a file. |
document.file.Move | Move files to a folder |
document.file.MoveToGarbageCollector | Permanently delete one or more files |
document.file.MoveToTrash | Delete one or more files |
document.file.NotifyOpen | Warn users that a specific file is being opened |
document.file.PathInfo | Get file path info |
document.file.RemoveProperty | Remove a property from a file |
document.file.RemoveTag | Remove a tag in a file |
document.file.RemoveTagByLabel | Remove a tag in a file using the label |
document.file.Restore | Restore one or more files |
document.file.SetPropertyValue | Set a property to a file |
document.file.Unlock | Used to unlock a file. |
document.file.Unversion | Unversion one file |
document.file.Upload | Upload a file |
document.general_file.GetOnlineEditionGeneralFileToken | Get file token for editing external file online using only office |
document.service.BringBack | Bring backs a service file back to the wimi (and removes the .html in wimi if it succeeds). Only works with google ATM. |
document.service.CheckToken | Check service token |
document.service.Download | Directly download the document from the service. Only google is supported right now. |
document.service.Edit | Edit (and upload) a file to service. Only google is supported right now. |
document.service.GetEntries | Get service entries |
document.service.ImportEntries | Import service entries |
document.service.LinkDirs | Link directories from service entries |
document.sharing.Activate | Activate sharing on one directory |
document.sharing.AllowInvisibleSub | Allow invisible subdirectories on a shared folder |
document.sharing.AllowUpload | Allow upload on a given shared folder |
document.sharing.Deactivate | Deactivate sharing on one directory |
document.sharing.DisallowInvisibleSub | Disallow invisible subs on a shared folder |
document.sharing.DisallowUpload | Disallow upload on a given shared folder |
document.sharing.ExportAsCsv | Activate sharing on one directory |
document.sharing.RemovePassword | Remove a password of a shared folder |
document.sharing.SetExpirationDate | Set an expiration date for an item |
document.sharing.SetPassword | Set a password for an item |
document.template.AddTag | Add a tag on a general file template |
document.template.CreateFromExternalFile | Create a file template from an external file |
document.template.CreateFromInternalFile | Create a template from an internal (already existent in account) file |
document.template.LinkTag | Link tag to template |
document.template.ListForAccount | List file templates of account |
document.template.PreviewTemplate | Request template preview |
document.template.RemoveTag | Remove tag from template |
document.template.Restore | Restore trashed file template |
document.template.Trash | Put file template to trash |
document.template.UpdateDescription | Update file template description |
document.template.UpdateName | Update file template name |
document.trash.EmptyTrash | Empty the trash |
document.trash.List | List the files found in the trash given a set of filters |
document.trash.RestoreFile | Restore one or more files |
document.validation.AddValidatorsToRequest | Add validators to a doc validation request |
document.validation.CreateRequest | Create a doc validation request |
document.validation.EditRequestDescription | Edit doc validation request description |
document.validation.ExportAccountValidationssAsXLS | Exports all document validations of the account as XLS |
document.validation.ExportMyValidationAsXLS | Exports all document validation the calling user has access to as XLS |
document.validation.ListRequests | List all doc validation requests for that user |
document.validation.ListRequestsAsRequester | List all doc validation requests associated to a requester |
document.validation.ListRequestsAsValidator | List all doc validation requests associated to a validator |
document.validation.ListResponses | List all doc validation responses for a user |
document.validation.RemindValidator | send a reminder email to a validator |
document.validation.RemoveRequest | Remove a doc validation request |
document.validation.RemoveValidatorsFromRequest | Remove validators from a doc validation request |
document.validation.ResetResponseStatus | Reset a response for a validator |
document.validation.UpdateRequestExpiryDate | Update expiry date of a doc validation request |
document.validation.UpdateRequestStatus | Update status of a doc validation request |
document.validation.UpdateResponseStatus | Update a response for a validator |
document.validation.exportMyRequestsAsXLS | Exports all document requests made by the calling user as XLS |
gantt.gantt.AddList | Add a list to gantt view |
gantt.gantt.BatchAddList | Add lists to gantt view |
gantt.gantt.BatchRemoveList | Batch remove lists from gantt view |
gantt.gantt.RemoveList | Remove a list from gantt view |
link.link.AddComment | Add a link comment |
link.link.AddTag | Add a tag on a link |
link.link.ConversationArchive | Archive a conversation |
link.link.ConversationClearUnseen | Clear unseen count for conversation |
link.link.ConversationSetSilent | Set silent for conversation |
link.link.CopyLink | Copy links from one directory into another |
link.link.DeleteComment | Delete a link comment |
link.link.Edit | Edit url and/or title of link |
link.link.EditComment | Edit a link comment |
link.link.GetComments | Get comments of a link |
link.link.GetEvents | Get the historical events of a link |
link.link.LinkTag | Link a tag to a link |
link.link.PathInfo | Get link path info |
link.link.RemoveTag | Remove a tag in a link |
link.link.RemoveTagByLabel | Remove a tag in a link using the label |
link.link.RestoreLink | Restore link from trash |
link.link.TrashLink | Put a list of links to trash |
main.account.ActivateUsers | Activate list of users |
main.account.AddUser | Add a user |
main.account.BatchUpdateUsersRole | Batch update role for user list |
main.account.DeactivateUsers | Deactivate list of users |
main.account.DeleteAccount | Delete the account |
main.account.DeleteUsers | Delete list of users permanently |
main.account.EditCategory | Edit a category |
main.account.EditUser | Edit a user |
main.account.ExportUsers | Export users in a file |
main.account.ExportUsersRights | Export users rights in a file |
main.account.GenerateAPIKey | Generate an API Key for the current account |
main.account.Get | Get account info |
main.account.GetAccountExternalInfo | Get external information for an account |
main.account.GetAccountPayingServices | Get the account paying services (available & selected with metadata) |
main.account.GetActivityRelatedRequestList | Get wapi routes that should update the activity unread counter |
main.account.GetAllAvailableUsers | Get all available users. Which mean a status will be returned. |
main.account.GetBillingInfo | List offers for account |
main.account.GetCalendars | Get the calendars of a user |
main.account.GetCategories | Get categories of a user |
main.account.GetGAppsUsers | Get gapps users and format the output to correspond the ones of Wimi |
main.account.GetListOfUsersSharingSameProjects | Get list of users sharing the same projects |
main.account.GetMemberListProjectsAuth | Get list of privileges on projects for a member list |
main.account.GetMemberProjectsAuth | Get list of privileges on projects for a member |
main.account.GetProject | Get a user project |
main.account.GetProjectTemplates | Get the project templates for that account |
main.account.GetProjects | Get projects of a user |
main.account.GetProjectsStats | Get projects stats for user available projects |
main.account.GetServiceUsers | Get the users of the given service and format the output to correspond the ones of Wimi |
main.account.GetSettings | Get settings for the account |
main.account.GetTutorialInfo | Return the necessary info to display the welcome tutorial |
main.account.GetUser | Get a user |
main.account.GetUserProjectsAuth | Get list of privileges on projects for a user |
main.account.GetUsers | Get all users |
main.account.ImportGAppsUser | Import a gapps user in wimi |
main.account.ImportUsersFromCSV | Import users from csv |
main.account.PayingServicesAddEntity | Add an entity of debit_type to the selected paying service |
main.account.RegenerateGeneralPassword | Regenerate the password of the Wimi Backup user of this account |
main.account.RemoveAPIKey | Remove an API Key for the current account |
main.account.SelfDeactivate | Deactivate the current user |
main.account.SetBillingInfo | Set billing info of account |
main.account.SetSettings | Set settings for the account |
main.account.SetUISetting | Customization - set ui settings |
main.account.SetWelcomeActivity | Set welcome activity |
main.account.ToggleSupportInterventionAuthorization | Toggle support intervention authorization on account |
main.account.ToggleThirdPartyService | Enable/Disable a third party service for the account |
main.group.AddMember | Add a member to a group |
main.group.AddTag | Add a tag on a user group |
main.group.BatchAddMembers | Batch add members to a group |
main.group.Create | Create a user group |
main.group.Delete | Delete a user group |
main.group.Edit | Edit a user group |
main.group.LinkTag | Link a tag to a group |
main.group.List | List the user group of this account |
main.group.RemoveMember | Remove a member from a group |
main.group.RemoveTag | Remove a tag in a user group |
main.group.RemoveTagByLabel | Remove a tag in a user group using the label |
main.personnalizedentry.AddChoice | add a choice to a personnalized entry of type qcu / qcm |
main.personnalizedentry.BatchUpdateEntryAccess | Insert object access for specified entry (workspace/users) |
main.personnalizedentry.BatchUpdateEntryProjectAuth | change entry access to workspace (module) |
main.personnalizedentry.Create | create a personnalized entry |
main.personnalizedentry.DeleteChoice | remove a choice |
main.personnalizedentry.DeleteEntries | Batch delete entries |
main.personnalizedentry.GetEntryGlobalAccess | get workspace / module access of an entry |
main.personnalizedentry.GetItemEntries | Get item entries and their value |
main.personnalizedentry.GetPersonnalizedEntries | get a personnalized entry |
main.personnalizedentry.GetWorkspaceEntryAccess | get specific workspace / module access of an entry |
main.personnalizedentry.MoveChoice | Move a choice to another position |
main.personnalizedentry.MoveEntry | Move a choice to another position |
main.personnalizedentry.RenameChoice | add a choice to a personnalized entry of type qcu / qcm |
main.personnalizedentry.SetEntryValue | Set value for the specified entry |
main.personnalizedentry.UpdateName | Update name of an entry |
main.project.ActivateModules | Activate modules on a project |
main.project.AddTag | Add a tag on a project |
main.project.Archive | Archive a project |
main.project.BatchSetUsersAuth | Set the auth on a project for a list of users |
main.project.Create | Create a project |
main.project.CreateFromTemplate | Create a project given a template |
main.project.DeactivateModules | Deactivate modules on a project |
main.project.Delete | Delete a project definitely |
main.project.GetProjectTagCountInFamily | |
main.project.GetTemplateList | Get list of templates for this account / user |
main.project.GetUsersAuth | Get list of all users auth on that project |
main.project.GetUsersList | Get list of all users in a project (via user_id) |
main.project.IsServiceAvailableForProject | Check whether project has specified paying service enabled. adds the access if add_paying_service is set to true |
main.project.LinkTag | Link a tag to a project |
main.project.RemoveTag | Remove a tag in a project |
main.project.RemoveTagByLabel | Remove a tag in a project using the label |
main.project.RemoveTagFamilyRestriction | Remove tag family restriction |
main.project.RemoveUserGroups | Removes user groups from a project |
main.project.RemoveUsers | Removes users from a project |
main.project.ReplaceUser | Replace a user in another in a project |
main.project.Restore | Unarchive a project |
main.project.SetDriveSync | Enable/Disable the drive synchronisation for all users |
main.project.SetMemberAuth | Set the member auth on a project |
main.project.SetTagFamilyRestriction | Set tag family restriction |
main.project.SetUserAuth | Set the user auth on a project |
main.project.SetUserGroupAuth | Set the user group auth on a project |
main.project.Update | Update a project. |
main.project.UpdateDefaultModule | Update default module |
main.saml.CreateServiceToken | Create a token that can be used by an external service to create a limited access token for that user |
main.saml.GetAccountList | Get a list of account associated to the user linked to the given access token |
main.search.AddRecentSearch | Add search to recent search user history |
main.search.ClearSearchHistory | Clear search history for specified user |
main.search.GetUserRecentSearch | Get user recent search history |
main.search.Search | Search items in the wimi with a query |
main.search.SearchMore | Ask for the next X results from Wimi's global search |
main.search.SearchPersonalizedEntries | Search items in the wimi with a query |
main.search.SearchProjects | Search through projects in the wimi with a query |
main.session.Load | Load some info about the session |
main.session.LoadExtra | Load some info about the session |
main.session.LoadProjects | Getting all projects the user has access to and their information |
main.session.LoadUsers | Getting all users the user can see and their information |
main.tag.AddTagsToFamilies | remove a family tag tag |
main.tag.BatchMergeTags | merge several tags into another |
main.tag.BatchRemove | remove several tags |
main.tag.ChangeColor | Change the color of a tag |
main.tag.Create | create a tag |
main.tag.CreateFamily | create a family tag |
main.tag.Get | get a tag |
main.tag.GetAll | get all tags for this account |
main.tag.GetByLabel | get a tag by its label |
main.tag.GetFamilyTags | get a family tag |
main.tag.GetStats | get tags stats for this account |
main.tag.ImportFromCSV | Import tags from csv |
main.tag.MergeTags | merge one tag into another |
main.tag.Remove | remove a tag (globally) |
main.tag.RemoveFamilyTag | remove a family tag tag |
main.tag.RemoveTagsFromFamily | remove a family tag tag |
main.tag.Rename | rename a tag (globally) |
main.tag.UpdateFamily | update a family tag |
main.user.AddTag | Add a tag on a user |
main.user.BatchLinkTag | Link a tag to a list of user |
main.user.BatchRemoveTag | Remove a tag in a list of users |
main.user.BatchUpdateProperty | Batch add or update properties for the user |
main.user.CreateLimitedToken | Create a token with restricted accesses to be used instead of the auth token from external applications |
main.user.CreateLimitedTokenForService | Create a token with restricted accesses for a specific service |
main.user.CreateServiceToken | Create a token that can be used by an external service to create a limited access token for that user |
main.user.DeleteLimitedToken | Delete a limited token |
main.user.DeleteServiceToken | Delete a user service token |
main.user.EditArmouredDevice | Add or edit a device |
main.user.EditAvatar | Update the avatar of a user |
main.user.GetArmouredDeviceList | Get all the device added and usable |
main.user.GetCaldavSyncSettings | Get Caldav synchronization settings |
main.user.GetGlobalStatus | Get global status of a user. |
main.user.GetNotificationSettings | get user notification settings (enabled/disabled) |
main.user.GetRelativeUsersId | Return the id list of all the users that can see this user (fellow + admins) |
main.user.GetSelf | Get self user |
main.user.GetTankerSecret | Return the tanker secret for current user |
main.user.GetUserServicesInfo | Get third party services info for a user |
main.user.LinkTag | Link a tag to a user |
main.user.ListProperties | Get all the user properties |
main.user.RemoveProperty | Remove a property for the user |
main.user.RemoveTag | Remove a tag in a user |
main.user.RemoveTagByLabel | Remove a tag in a user using the label |
main.user.RevokeService | Revoke a third party service for a user |
main.user.SendArmouredVerificationEmail | Send a mail to the user so he can validate his identity |
main.user.SetNotificationSettings | set user notification settings (enabled/disabled) |
main.user.SetProjectCaldavSync | Set Caldav synchronization for a project |
main.user.SetStatus | Set the status of the user. Status is linked to the session_id. |
main.user.SetUserLanguage | Set a user language |
main.user.SetUserStatus | Set the status of the user. |
main.user.Update | Update the user information |
main.user.UpdateProperty | Add or update a property for the user |
main.util.GetSpecificTrad | Get specific trad in specific lang |
meeting.meeting.Add | Add a meeting |
meeting.meeting.AddDates | Add dates to a meeting |
meeting.meeting.AddExternalParticipants | Add external participants to a meeting |
meeting.meeting.AddInternalParticipants | Add internal participants to a meeting |
meeting.meeting.Delete | Delete a meeting |
meeting.meeting.Edit | Edit a meeting |
meeting.meeting.FixDate | Fix a date |
meeting.meeting.Get | Get a meeting |
meeting.meeting.GetList | Get meetings |
meeting.meeting.RemoveParticipants | Remove participants from a meeting |
meeting.meeting.UnfixDate | Unfix a date |
meeting.meeting.UpdateStatus | Add external users to a meeting |
poll.poll.Vote | Vote for a poll |
reporting.task.Burndown | Get burndown |
reporting.task.Load | Load all stats |
reporting.task.Performance | Get performance |
reporting.task.Status | Get status |
reporting.task.Tags | Get tags |
reporting.task.Workload | Get workload |
sharing.sharing.Download | Download a file from a sharing folder |
sharing.sharing.DownloadFile | Download a file from a sharing file |
sharing.sharing.Folder | List entries of folder |
sharing.sharing.Load | Get information required to load sharing doc page |
sharing.sharing.LoadFile | Get information required to load file sharing page |
sharing.sharing.RequestLinkPreview | |
sharing.sharing.Upload | Upload a file via a sharing folder |
social.community.Archive | Archive a community |
social.community.Create | Create a community |
social.community.Delete | Delete a community |
social.community.GetArchivedList | Get the list of archived community for a user |
social.community.GetAuthList | Get a list of community member auth |
social.community.GetDiscoveryList | Get the list of community for a user to discover |
social.community.GetFavoritePostList | Get the list of favorite post |
social.community.GetList | Get the list of community for a user |
social.community.GetPinnedPostList | Get a list of pinned post for a community |
social.community.GetPostList | Get a list of post |
social.community.GetRecentPostList | Get a list of recent post for a community list |
social.community.GetUnseenActivity | Get a list of unseen activity |
social.community.PublishPost | Publish into a community |
social.community.RemoveMember | Remove a member from the community |
social.community.Subscribe | Subscribe to a community |
social.community.ToggleFavorite | Toggle favorite for a community |
social.community.Unarchive | Unarchive a community |
social.community.Unsubscribe | Unsubscribe from a community |
social.community.Update | Update a community |
social.community.UpdateAuthList | Update (add or create) the list of auth for a community |
social.community.UpdateAvatar | Update a community avatar |
social.community.UpdateBackground | Update a community background cover |
social.community.UpdatePost | Update a post |
social.post.AddExternalAttachment | Attach an external file to a post |
social.post.ClearUnseen | Flag posts as seen |
social.post.DeleteComment | Delete a comment on a post |
social.post.DeletePost | Delete a post |
social.post.DownloadAttachment | Download a post attachment |
social.post.EditComment | Edit a comment on a post |
social.post.PreviewAttachment | Request attachment preview |
social.post.PublishComment | Publish a comment on a post |
social.post.RemoveExternalAttachment | Remove an external attachment from a community post |
social.post.SetIntegrationAttachment | Set the integration attachment for a post |
social.post.ToggleCommentsEnabled | Toggle comments enabled for a community post |
social.post.ToggleFavorite | Toggle favorite for a community post |
social.post.TogglePinned | Toggle pinned for a community post |
social.post.ToggleReaction | Toggle a reaction to a post |
task.filter.Add | Adds a filter on tasks to the project or on unified tasks |
task.filter.Apply | Apply a filter on the tasks of the given projects |
task.filter.Delete | Delete a filter |
task.filter.Edit | Edits a filter on tasks |
task.filter.Get | Get a tasks filter |
task.filter.List | List tasks filters |
task.filter.ListUnified | List unified tasks filters |
task.subtask.AddOwners | Add Owner to a subtask |
task.subtask.ChangeStatus | Change status of a subtask |
task.subtask.Create | Create a subtask for the given task |
task.subtask.Delete | Delete a subtask |
task.subtask.Move | Move a subtask to another position (and/or task) |
task.subtask.RemoveOwners | Add Owner to a subtask |
task.subtask.Update | Update a subtask |
task.task.AddBatchOwner | Get all tasks of a list |
task.task.AddComment | Add a comment to a task |
task.task.AddExternalAttachment | Attach an external file to a task |
task.task.AddExternalAttachmentFromTemplate | Attach an external file to a task, from a template |
task.task.AddReminder | Add a reminder for a task |
task.task.AddTag | Add a tag in a task |
task.task.AddWimiAttachment | Attach a wimi file to a task |
task.task.BatchDelete | Delete a batch of tasks |
task.task.BatchDuplicate | Copy a batch of tasks |
task.task.BatchLinkTag | Link a tag to a list of tasks |
task.task.BatchMove | Move a batch of tasks to a position |
task.task.BatchMoveAfter | Move a batch of tasks after another |
task.task.BatchRemoveTag | Remove a tag in list of tasks |
task.task.ChangeStatus | Change the status of a given task |
task.task.ChangeStatusBulk | Change the status of several tasks |
task.task.ConversationArchive | Archive conversation |
task.task.ConversationClearUnseen | Clear unseen count for conversation |
task.task.ConversationSetSilent | Set silent for conversation |
task.task.Create | Create a task |
task.task.Delete | Delete a task |
task.task.DeleteComment | Delete a task comment |
task.task.DeleteDates | Delete Dates from a Task |
task.task.DisableRecurrence | Disable a recurrence for a task |
task.task.DownloadAttachment | Attach a file to a task |
task.task.Duplicate | Copy a task |
task.task.EditComment | Edit a comment of a task |
task.task.Follow | Add self as follower to this task |
task.task.GenerateNextOccurrence | Generate the next occurrence of a task |
task.task.GenerateWOGeneralFile | create an external file to a task |
task.task.Get | Get a task with all its data |
task.task.GetAll | Get all tasks of a list |
task.task.GetAttachmentList | Get the list of files attached to a task |
task.task.GetNbNotCompletedForProject | Get the total amount of not completed tasks for the given project |
task.task.History | Get a task history |
task.task.LinkTag | Link a tag to a task |
task.task.Move | Move a task to new position |
task.task.MoveAfter | Move a task after another |
task.task.PreviewAttachment | Request attachment preview |
task.task.Relocate | Relocate a task in an other project |
task.task.RemoveBatchOwners | Get all tasks of a list |
task.task.RemoveExternalAttachment | remove an external attachment from the task |
task.task.RemoveReminder | Remove a reminder for a task |
task.task.RemoveTag | Remove a tag in a task |
task.task.RemoveTagByLabel | Remove a tag in a task using the label |
task.task.RemoveWimiAttachment | Remove a wimi attachment from a task |
task.task.SendReminder | send a reminder to the owners of a task |
task.task.SetRecurrence | Set or update a recurrence for the given task |
task.task.ToggleDefaultOverdueAlert | Add or remove the default overdue alert for a task |
task.task.Unfollow | Remove self as follower from this task |
task.task.Update | Update a task |
task.tlist.AddLink | Create a link between 2 lists given a specific relation type |
task.tlist.BatchSetHidden | Set the tasks lists the user does not want to display |
task.tlist.ChangeLine | Change line in gantt view |
task.tlist.Copy | |
task.tlist.Create | Create a task list |
task.tlist.Dashboard | Get all necessary data for displaying the tasks module dashboard |
task.tlist.DashboardGlobal | Get all necessary data for displaying the tasks module dashboard Same as dashboard but for a user, not a project |
task.tlist.Delete | Delete a task list |
task.tlist.ExportAsCSV | Exports all tasks and lists of a project as csv |
task.tlist.ExportAsXLS | Exports all tasks and lists of a project as XLS |
task.tlist.ExportFilteredAsXLS | Exports all tasks and lists as csv given filter options |
task.tlist.Follow | Add self as follower to this list |
task.tlist.GetAcceptedTasks | Get all Tasks that are accepted |
task.tlist.GetAll | Returns all tasks lists of a project |
task.tlist.GetList | Returns a task list with its stats |
task.tlist.ImportFromCSV | Import tasks and lists from csv |
task.tlist.ImportFromXLS | Import tasks and lists from xls |
task.tlist.Move | Move a task list |
task.tlist.RemoveLink | Remove link between 2 lists |
task.tlist.Unfollow | Remove self as follower from this list |
task.tlist.Update | Update a task list |
task.tlist.UpdateDates | Move a list in a line |
task.tlist.UpdateExcludeAcceptedTask | |
task.trash.List | List all trashed tasks lists and their tasks (also trashed) |
Used to login a user and retrieve an access token
The account must be valid and the user must be activated
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "auth.user.Login", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": {} }, "body": { "data": { "list_projects": true, "projects_auth": true, "projects_stats": true, "projects_tasks_stats": true, "projects_users": true, "manual": true, "token": "some text", "fetch_pwd_sha": true } } }
Used to logout a user
keep_self removes all sessions of the user except this one kill_all removes all the sessions of the user, including this one both set to false only remove this session both set to true throws a 400
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "auth.user.Logout", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "keep_self": true, "kill_all": true } } }
Clear the activity unread count
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.ClearUnreadCount", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": {} } }
export the list of activity events in a CSV file
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.ExportAsCSV", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id_list": [ 12345, 12346 ] } }, "body": { "data": { "min_date": "2016-11-27 17:10:05", "max_date": "2016-11-27 17:10:05", "type_list": [ 12345, 12346 ], "csv_delimiter": "some text", "csv_enclosure": "some text", "user_id_list": [ 12345, 12346 ], "filter": "some text", "with_account_event": true } } }
Get a list of activity events
Get a list of activity events based on the given parameters
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.GetList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id_list": [ 12345, 12346 ] } }, "body": { "data": { "min_date": "2016-11-27 17:10:05", "max_date": "2016-11-27 17:10:05", "limit": 12345, "user_id_list": [ 12345, 12346 ], "filter": "some text", "with_account_event": true, "type_list": [ 12345, 12346 ] } } }
Ask for the next X results from events
If we are only displaying the first 100 results, this request should return the next 100 results, etc...
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.GetNextList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id_list": [ 12345, 12346 ] } }, "body": { "data": { "min_date": "2016-11-27 17:10:05", "max_date": "2016-11-27 17:10:05", "limit": 12345, "user_id_list": [ 12345, 12346 ], "filter": "some text", "with_account_event": true, "type_list": [ 12345, 12346 ], "current_result_count": 12345 } } }
Get a list of activity events notified for the contexted user
Get a list of activity events notified for the contexted user
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.GetNotifications", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "limit": 12345 } } }
Get unread event count by projects
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.GetUnreadCount", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "limit": 12345 } } }
Used to generate push message
Push is sent when we generate an event for an item
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.NewEvent", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": {} } }
Used to generate push message
Push is sent when we generate a list of event for an item
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "activity.event.NewEventList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": {} } }
Add a comment to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.AddComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "comment": "some text" } } }
Attach an external file to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.AddExternalAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "file_timestamp": "some text", "name": "some text", "size": 12345 } } }
Attach an external file to a calendar event, from a template
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.AddExternalAttachmentFromTemplate", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "file_template_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Add external participant for a specific event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.AddExternalParticipants", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "external_user_list": [ { "email": "external_user1@domain.com", "first_name": "first_name1", "last_name": "last_name1" }, { "email": "external_user2@domain.com", "first_name": "first_name2", "last_name": "last_name2" } ] } } }
Add a tag to a Calendar Event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.AddTag", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "label": "mylabel1" } }, "body": { "data": {} } }
Attach a wimi file to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.AddWimiAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "file_id": 12345 } }, "body": { "data": {} } }
Change Status of Agenda Event Participant. Accept / Refuse invite to an event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "calendar.event.ChangeInviteStatus", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "status": 12345 } } }
Archive a conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.ConversationArchive", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Clear unseen count for conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.ConversationClearUnseen", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Set silent for conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.ConversationSetSilent", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "silent": true, "silent_until": "2016-11-27 17:10:05" } } }
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.CopyEventList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id_list": [ 12345, 12346 ] } }, "body": { "data": { "recurrence_id_list": [ 1, 2, 3, 4 ] } } }
Create a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.Create", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "event": "no example yet" } } }
Delete a calendar event comment
Mark the message as deleted, does not delete it entirely
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.DeleteComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "comment_id": 12345 } }, "body": { "data": {} } }
Download a calendar event attachment
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.DownloadAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "attachment_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Edit a comment of a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.EditComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "comment_id": 12345 } }, "body": { "data": { "comment": "some text" } } }
create an external file to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.GenerateWOGeneralFile", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "name": "some text", "file_format": "some text" } } }
Get the details of a calendar events
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.Get", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
get the list of files attached to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetAttachmentList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Get teh comments of a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetComments", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Download the ics for a specific event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetDownloadInviteLink", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Get external participant for a specific event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetExternalParticipants", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
Get a list of events
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "start_date": "2016-11-27 17:10:05", "end_date": "2016-11-27 17:10:05", "filters": [ 12345, 12346 ], "view_busy": true, "busy_user_id_list": [ 12345, 12346 ], "view_empty_events": true, "calendar_event_id_list": [ 12345, 12346 ], "gen_rec_occurrences": true, "modified_after": 12345 } } }
Get a list of events for unified calendars
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "calendar.event.GetListUnified", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "start_date": "2016-11-27 17:10:05", "end_date": "2016-11-27 17:10:05", "filters": [ 12345, 12346 ], "project_id_list": [ 12345, 12346 ], "user_id_list": [ 12345, 12346 ], "gen_rec_occurrences": true, "view_empty_events": true } } }
Get a calendar subscription link
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.GetSubscriptionLink", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": {} } }
Get calendar subscription link for unified projects
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "calendar.event.GetUnifiedSubscriptionLink", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": {} } }
Link a tag to a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.LinkTag", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "tag_id": 12345 } }, "body": { "data": {} } }
Request attachment preview
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "calendar.event.PreviewAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "attachment_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "preview_type": "some text" } } }
Delete a calendar event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.Remove", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": {} } }
remove an external attachment from the calendar
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.RemoveExternalAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "attachment_id": 12345 } }, "body": { "data": {} } }
Remove external participant for a specific event
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.RemoveExternalParticipants", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "external_user_id_list": [ 12345, 12346 ] } } }
Delete a recurrence occurrence
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.RemoveRecurrenceOccurrence", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "recurrence_id": "2016-11-27 17:10:05" } } }
Remove a tag in a task
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.RemoveTag", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "tag_id": 12345 } }, "body": { "data": {} } }
remove a wimi attachment from the calendar
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.RemoveWimiAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "attachment_id": 12345 } }, "body": { "data": {} } }
Update a calendar event - only the provided data are updated.
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.Update", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345 } }, "body": { "data": { "event": "no example yet" } } }
Move a calendar event from one project to another
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "calendar.event.UpdateProject", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "calendar_event_id": 12345, "target_project_id": 12346 } }, "body": { "data": {} } }
Attach a file to a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.AddAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "attachment_title": "some text", "attachment_description": "some text", "name": "some text", "size": 12345 } } }
Attach a internal file to a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.AddInternalAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "file_id": 12345 } }, "body": { "data": {} } }
Add members to a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.AddMembers", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "member_id_list": [ { "member_type_id": 1, "member_id": 12345 }, { "member_type_id": 2, "member_id": 12345 } ] } }, "body": { "data": {} } }
Add users to a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.AddUsers", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "user_id_list": [ 12345, 12346 ] } }, "body": { "data": {} } }
Send a notification that the user canceled typing
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.CanceledTyping", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Clear unseen count for chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.ClearUnseen", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Create a group chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.Create", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "users": [ 12345, 12346 ], "user_groups": [ 12345, 12346 ], "name": "some text", "use_existing": true, "force_creation": true } } }
Create channel chat
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.CreateChannel", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": {} } }
Delete a message
Mark the message as deleted, does not delete it entirely
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.DeleteMessage", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "message_index": 12345 } } }
Disable a chat for a user
Remove the chat from the recent chats
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.Disable", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Download a chat attachment
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.DownloadAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "file_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Edit a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.EditMessage", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "message": "some text", "message_index": 12345 } } }
Edit a chat name
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.EditName", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Favorite a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.FavoriteMessage", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "message_index": 12345 } } }
Get attachment list
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetAttachmentList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Get chat
with or without messages, default with
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetChat", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "with_messages": true, "limit": 12345 } } }
Get favorite list
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetFavorites", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Get shared links in a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetLinks", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Get chat list
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "comment_count": true } } }
Search through chat messages
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.GetMessageBeforeAfter", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "message_index": 12345 } } }
Get chat messages from offset of given message id, until limit
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.LoadMessages", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "offset": 12345, "limit": 12345 } } }
Post message to chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.PostMessage", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "message": "some text", "integration_attachment": "no example yet" } } }
Request attachment preview
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.PreviewAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "preview_type": "some text" } } }
Remove members from a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.RemoveMembers", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "member_id_list": [ { "member_type_id": 1, "member_id": 12345 }, { "member_type_id": 2, "member_id": 12345 } ] } }, "body": { "data": {} } }
Remove users from a chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.RemoveUsers", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "user_id_list": [ 12345, 12346 ] } }, "body": { "data": {} } }
Search through chat messages
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.Search", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "search": "some text" } } }
Set the integration attachment for a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.SetMessageIntegrationAttachment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "integration_attachment": "no example yet" } } }
Set silent for chat
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.SetSilent", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": { "silent": true, "silent_until": "2016-11-27 17:10:05" } } }
Send a notification that the user is typing
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.StartedTyping", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345 } }, "body": { "data": {} } }
Unfavorite a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.UnfavoriteMessage", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "message_index": 12345 } } }
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.chat.UpdateGroupChatProfilePicture", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "chat_id": 12345, "name": "some text", "size": 12345 } } }
Add a reaction for a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.message.AddMessageReaction", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "reaction": "copyright" } } }
Delete a reaction for a message
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "chat.message.DeleteMessageReaction", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "chat_id": 12345, "message_id": 12345 } }, "body": { "data": { "reaction": "copyright" } } }
Get a specific user commented item
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "comment.comment.GetCommentsForItem", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "item_id": 12345, "item_type_id": 12345 } }, "body": { "data": {} } }
Get user commented items
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "comment.comment.GetUserCommentedItems", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": {} } }
create a persistent room
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "communication.air.CreatePersistentRoom", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "name": "some text", "image": 12345 } } }
Get persistent airtime room
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
{ "header": { "target": "communication.air.GetPersistentRoom", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345 } }, "body": { "data": { "room_id": 12345 } } }
Add comment to a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.AddComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": { "comment": "some text" } } }
Add link to directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.AddLink", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "url": "mylabel1", "title": "mylabel1" } } }
Add members to dir
Return all users having access to dir
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.AddMembersToDir", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "group_member_list": [ { "member_type_id": 1, "member_id": 12345 }, { "member_type_id": 2, "member_id": 12345 } ] } }, "body": { "data": {} } }
Archive a conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.ConversationArchive", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Clear unseen count for conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.ConversationClearUnseen", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Set silent for conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.ConversationSetSilent", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": { "silent": true, "silent_until": "2016-11-27 17:10:05" } } }
Copy a directory elsewhere
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.Copy", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Copy a list of directory elsewhere
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.CopyList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id_list": [ 1193, 5253, 80983, 912 ] } }, "body": { "data": { "copy_meta": true } } }
Creates a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.Create", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Creates a directory tree when uploading a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.CreateDirectoryTree", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "relative_path_list": [ "string1", "string2", "string3" ] } }, "body": { "data": {} } }
Delete a directory comment
Mark the message as deleted, does not delete it entirely
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.DeleteComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "comment_id": 12345 } }, "body": { "data": {} } }
Get the list of denied directories for a user
Project members (0) | Project administrators (5) |
X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.DeniedList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "group_member": { "member_type_id": 1, "member_id": 12345 } } }, "body": { "data": {} } }
Edit a comment of a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.EditComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "comment_id": 12345 } }, "body": { "data": { "comment": "some text" } } }
Edits members access on one or several directories
Project members (0) | Project administrators (5) |
X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.EditMembersAccessToDirectories", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "member_id_list": [ { "member_type_id": 1, "member_id": 12345 }, { "member_type_id": 2, "member_id": 12345 } ] } }, "body": { "data": { "dir_access_array": { "1": 0, "2": 1, "5": 2 } } } }
Edits the name of a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.EditName", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Get comments of a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.GetComments", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Get list of all users having access to given directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.GetDirectoryUsers", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Get users access of a dir
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.GetMembersAccess", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Get the read only state of the directory for the current user
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.GetReadOnlyStateForUser", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Get file path info
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.LinkPathInfo", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "link_id": 12345 } }, "body": { "data": {} } }
Move directories to a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.Move", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id_list": [ 1193, 5253, 80983, 912 ] } }, "body": { "data": { "conflict_rename": true } } }
Move links from one directory to another
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.MoveLink", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "link_id_list": [ 12345, 12346 ] } }, "body": { "data": {} } }
Permanently delete one or more directories
Project members (0) | Project administrators (5) |
X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.MoveToGarbageCollector", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id_list": [ 1193, 5253, 80983, 912 ] } }, "body": { "data": {} } }
Delete one or more directories
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.MoveToTrash", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id_list": [ 1193, 5253, 80983, 912 ] } }, "body": { "data": {} } }
Get directory path info
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.directory.PathInfo", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": {} } }
Remove members from dir
Return all users having access to dir
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.RemoveMembersFromDir", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "group_member_list": [ { "member_type_id": 1, "member_id": 12345 }, { "member_type_id": 2, "member_id": 12345 } ] } }, "body": { "data": {} } }
Remove a property from a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.RemoveProperty", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "property_label": "mylabel1" } }, "body": { "data": { "subdirs": true } } }
Restore one or more directories from trash
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.Restore", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id_list": [ 1193, 5253, 80983, 912 ] } }, "body": { "data": { "dir_id": 12345 } } }
Get comments of a directory
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.SetDirectoryDefault", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345 } }, "body": { "data": { "access": 12345 } } }
Add a property to a directory
subdirs: whether or not we apply this property to all subdirs of dir Return list of dir id affected by the property and its value
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.directory.SetPropertyValue", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "dir_id": 12345, "property_label": "mylabel1" } }, "body": { "data": { "value": "mylabel1", "subdirs": true } } }
List folders found in a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.entry.DirList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": {} } }
Get flat tree for project
Get a flat tree, ordered by path
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.entry.GetProjectTree", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": {} } }
List the files and folders found in a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.entry.List", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "no_comment_count": true, "process_thumbnail": true } } }
List the service entries of a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.entry.ListServiceEntries", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "cloud_reference": "some text" } } }
List the files, the link and folders found in the trash
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.entry.TrashList", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": {} } }
Activate sharing on one file
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.file.ActivateSharing", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "file_id": 12345 } }, "body": { "data": {} } }
Add a file comment
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.file.AddComment", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "comment": "some text" } } }
Add a tag on a file
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.file.AddTag", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "file_master_id": 12345, "label": "mylabel1" } }, "body": { "data": {} } }
Take an attachment from chat or task and add it to the documennt module
Take an attachment from chat or task and add it to the document module
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.file.AttachmentIntoDoc", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "attachment_id": 12345 } }, "body": { "data": {} } }
check a file name conflict
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.file.CheckConflict", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "name": "some text" } } }
Check conflicts of a specific name in a folder
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X |
{ "header": { "target": "document.file.CheckConflicts", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345 } }, "body": { "data": { "file_name": "some text" } } }
Archive a conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.file.ConversationArchive", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "file_master_id": 12345 } }, "body": { "data": {} } }
Clear unseen count for conversation
Project members (0) | Project administrators (5) |
X | X |
Guests (-5) | Contributors (0) | Managers (1) | Administrators (2) | Account manager (3) |
X | X | X | X | X |
Read-only (1) | Read-write (2) |
X | X |
{ "header": { "target": "document.file.ConversationClearUnseen", "api_version": "1.2", "app_token": "You can generate one from your account settings", "msg_key": "message key also returned in the response", "token": "user session token returned by auth.user.Login", "identification": { "account_id": 12345, "user_id": 12345, "project_id": 12345, "file_master_id": 12345 } }, "body": { "data": {} } }
Set silent for conversation