{"info":{"title":"CapLinked API v1.0","description":"Core information security endpoints for managing files/folders, users/groups, uploads/downloads, and more.","version":"1.0.0"},"swagger":"2.0","produces":["application/json; charset=UTF-8","application/octet-stream"],"host":"secure.caplinked.com","basePath":"/api/v1","schemes":["https"],"tags":[{"name":"files","description":"Operations about files"},{"name":"activities","description":"Operations about activities"},{"name":"downloads","description":"Operations about downloads"},{"name":"folders","description":"Operations about folders"},{"name":"groups","description":"Operations about groups"},{"name":"organization","description":"Operations about organizations"},{"name":"permissions","description":"Operations about permissions"},{"name":"teams","description":"Operations about teams"},{"name":"users","description":"Operations about users"},{"name":"user","description":"Operations about users"},{"name":"watermark","description":"Operations about watermarks"},{"name":"workspaces","description":"Operations about workspaces"}],"paths":{"/files/search":{"get":{"summary":"Search files","description":"Search files in a workspace by title or indexed content.","produces":["application/json"],"parameters":[{"in":"query","name":"workspace_id","description":"Workspace ID","type":"integer","format":"int32","required":true},{"in":"query","name":"q","description":"Search term","type":"string","required":true},{"in":"query","name":"page","description":"Page number","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Results per page","type":"integer","format":"int32","default":25,"enum":[25,50,75,100],"required":false}],"responses":{"200":{"description":"Search files in a workspace by title or indexed content.","schema":{"type":"array","items":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileSearchResult"}}}},"tags":["files"],"operationId":"getFilesSearch"}},"/files/upload":{"put":{"summary":"Upload file","description":"Create or update a file with the same file name. Request body should be the file body itself as binary data.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putFilesUpload","in":"body","required":true,"schema":{"$ref":"#/definitions/putFilesUpload"}}],"responses":{"200":{"description":"Create or update a file with the same file name. Request body should be the file body itself as binary data.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileInfoCompact"}}},"tags":["files"],"operationId":"putFilesUpload"}},"/files/info/batch":{"post":{"summary":"Translation missing: en.file.file_info.batch.summary","description":"Translation missing: en.file.file_info.batch.description","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postFilesInfoBatch","in":"body","required":true,"schema":{"$ref":"#/definitions/postFilesInfoBatch"}}],"responses":{"201":{"description":"Translation missing: en.file.file_info.batch.description","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileInfoCompact"}}},"tags":["files"],"operationId":"postFilesInfoBatch"}},"/files/{id}":{"get":{"summary":"Get file information","description":"Get file information","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of file","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of workspace","type":"integer","format":"int32","required":true},{"in":"query","name":"page_number","description":"Page number of file (for viewer tokens)","type":"integer","format":"int32","default":1,"required":false}],"responses":{"200":{"description":"Get file information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileInfoMapped"}}},"tags":["files"],"operationId":"getFilesId"},"put":{"summary":"Update file information","description":"Update file information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of file","type":"integer","format":"int32","required":true},{"name":"putFilesId","in":"body","required":true,"schema":{"$ref":"#/definitions/putFilesId"}}],"responses":{"200":{"description":"Update file information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileInfoMapped"}}},"tags":["files"],"operationId":"putFilesId"},"delete":{"summary":"Delete file","description":"Delete file","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of file to delete","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete file","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileDelete"}}},"tags":["files"],"operationId":"deleteFilesId"}},"/files/{id}/copy":{"post":{"summary":"Copy file","description":"Copy file into another folder (existing file will not be modified)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of file to copy","type":"integer","format":"int32","required":true},{"name":"postFilesIdCopy","in":"body","required":true,"schema":{"$ref":"#/definitions/postFilesIdCopy"}}],"responses":{"201":{"description":"Copy file into another folder (existing file will not be modified)","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileCopyMove"}}},"tags":["files"],"operationId":"postFilesIdCopy"}},"/files/{id}/move":{"post":{"summary":"Move file","description":"Move file into another folder","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of file to move","type":"integer","format":"int32","required":true},{"name":"postFilesIdMove","in":"body","required":true,"schema":{"$ref":"#/definitions/postFilesIdMove"}}],"responses":{"201":{"description":"Move file into another folder","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileCopyMove"}}},"tags":["files"],"operationId":"postFilesIdMove"}},"/activities/workspace/{workspace_id}":{"get":{"summary":"Get workspace activities","description":"Get workspace activities","produces":["application/json"],"parameters":[{"in":"path","name":"workspace_id","description":"ID of the workspace","type":"integer","format":"int32","required":true},{"in":"query","name":"user_id","description":"ID of the user ","type":"integer","format":"int32","required":false},{"in":"query","name":"page","description":"Page number of results","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"Per page number of results. Options: 25, 50, 75, 100","type":"integer","format":"int32","default":100,"enum":[25,50,75,100],"required":false}],"responses":{"200":{"description":"Get workspace activities","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Activity"}}},"tags":["activities"],"operationId":"getActivitiesWorkspaceWorkspaceId"}},"/downloads":{"post":{"summary":"Create zip file","description":"Create download object containing folders and/or files","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postDownloads","in":"body","required":true,"schema":{"$ref":"#/definitions/postDownloads"}}],"responses":{"201":{"description":"Create download object containing folders and/or files","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Download_Meta"}}},"tags":["downloads"],"operationId":"postDownloads"}},"/downloads/status/{workspace_id}":{"get":{"summary":"Get status of downloads for current user","description":"Get status of downloads created by current user within a specified workspace","produces":["application/json"],"parameters":[{"in":"path","name":"workspace_id","description":"ID of Workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get status of downloads created by current user within a specified workspace","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Download_Meta"}}},"tags":["downloads"],"operationId":"getDownloadsStatusWorkspaceId"}},"/downloads/{id}":{"get":{"summary":"Get zip","description":"Get a zip file of a previously created download object","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of download","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of Workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get a zip file of a previously created download object","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Download_ExpiringUrl"}}},"tags":["downloads"],"operationId":"getDownloadsId"},"delete":{"summary":"Delete download","description":"Delete download","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of download to delete","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of Workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete download","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Download_Delete"}}},"tags":["downloads"],"operationId":"deleteDownloadsId"}},"/downloads/file/{file_id}":{"get":{"summary":"Get single file","description":"Download single file without DRM applied","produces":["application/json"],"parameters":[{"in":"path","name":"file_id","description":"ID of file to download","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of Workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Download single file without DRM applied","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Download_ExpiringUrl"}}},"tags":["downloads"],"operationId":"getDownloadsFileFileId"}},"/folders":{"post":{"summary":"Create new folder","description":"Create new folder","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postFolders","in":"body","required":true,"schema":{"$ref":"#/definitions/postFolders"}}],"responses":{"201":{"description":"Create new folder","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderMeta"}}},"tags":["folders"],"operationId":"postFolders"}},"/folders/{id}":{"get":{"summary":"Get folder information, subfolders and immediate subfiles.","description":"Get folder information\n If you are an admin and specify the folder id as 0, the endpoint returns the root folder directory of the workspace.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of workspace","type":"string","required":true}],"responses":{"200":{"description":"Get folder information\n If you are an admin and specify the folder id as 0, the endpoint returns the root folder directory of the workspace.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderContent"}}},"tags":["folders"],"operationId":"getFoldersId"},"put":{"summary":"Update folder information","description":"Update folder information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Update folder name and index","type":"integer","format":"int32","required":true},{"name":"putFoldersId","in":"body","required":true,"schema":{"$ref":"#/definitions/putFoldersId"}}],"responses":{"200":{"description":"Update folder information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderMeta"}}},"tags":["folders"],"operationId":"putFoldersId"},"delete":{"summary":"Delete folder","description":"Delete folder","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder to delete","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of workspace","type":"string","required":true}],"responses":{"200":{"description":"Delete folder","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderDelete"}}},"tags":["folders"],"operationId":"deleteFoldersId"}},"/folders/{id}/copy":{"post":{"summary":"Copy folder","description":"Copy folder into another folder (existing folder will not be modified). The copied folder will inherit group folder permissions from its new parent folder.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder to copy","type":"integer","format":"int32","required":true},{"name":"postFoldersIdCopy","in":"body","required":true,"schema":{"$ref":"#/definitions/postFoldersIdCopy"}}],"responses":{"201":{"description":"Copy folder into another folder (existing folder will not be modified). The copied folder will inherit group folder permissions from its new parent folder.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderCopyMove"}}},"tags":["folders"],"operationId":"postFoldersIdCopy"}},"/folders/{id}/move":{"post":{"summary":"Move folder","description":"Move folder into another folder","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder to move","type":"integer","format":"int32","required":true},{"name":"postFoldersIdMove","in":"body","required":true,"schema":{"$ref":"#/definitions/postFoldersIdMove"}}],"responses":{"201":{"description":"Move folder into another folder","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderCopyMove"}}},"tags":["folders"],"operationId":"postFoldersIdMove"}},"/groups":{"post":{"summary":"Create group","description":"Create group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postGroups","in":"body","required":true,"schema":{"$ref":"#/definitions/postGroups"}}],"responses":{"201":{"description":"Create group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"postGroups"},"get":{"summary":"List all groups in workspace","description":"List all groups in workspace","produces":["application/json"],"parameters":[{"in":"query","name":"workspace_id","description":"ID of workspace from which to list groups","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List all groups in workspace","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"getGroups"}},"/groups/{id}":{"put":{"summary":"Update group","description":"Update group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group","type":"integer","format":"int32","required":true},{"name":"putGroupsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsId"}}],"responses":{"200":{"description":"Update group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsId"},"get":{"summary":"Get group information","description":"Get group information","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"Workspace ID for the group","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get group information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"getGroupsId"},"delete":{"summary":"Delete group","description":"Delete group","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"Workspace ID for the group","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfoDeleted"}}},"tags":["groups"],"operationId":"deleteGroupsId"}},"/groups/{id}/drm":{"put":{"summary":"Update DRM for group","description":"Update DRM for group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"name":"putGroupsIdDrm","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsIdDrm"}}],"responses":{"200":{"description":"Update DRM for group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsIdDrm"}},"/groups/{id}/disable_drm_expiration":{"put":{"description":"Disable DRM expiration for group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"name":"putGroupsIdDisableDrmExpiration","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsIdDisableDrmExpiration"}}],"responses":{"200":{"description":"Disable DRM expiration for group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsIdDisableDrmExpiration"}},"/groups/{id}/watermarking":{"put":{"summary":"Watermarking for group","description":"Watermarking for group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"name":"putGroupsIdWatermarking","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsIdWatermarking"}}],"responses":{"200":{"description":"Watermarking for group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsIdWatermarking"}},"/groups/{id}/enable_expire_access":{"put":{"summary":"Enable access expiration for a group","description":"Enable access expiration for a group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"name":"putGroupsIdEnableExpireAccess","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsIdEnableExpireAccess"}}],"responses":{"200":{"description":"Enable access expiration for a group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsIdEnableExpireAccess"}},"/groups/{id}/disable_expire_access":{"put":{"summary":"Disable access expiration for a group","description":"Disable access expiration for a group","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of group to update","type":"integer","format":"int32","required":true},{"name":"putGroupsIdDisableExpireAccess","in":"body","required":true,"schema":{"$ref":"#/definitions/putGroupsIdDisableExpireAccess"}}],"responses":{"200":{"description":"Disable access expiration for a group","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Group_GroupInfo"}}},"tags":["groups"],"operationId":"putGroupsIdDisableExpireAccess"}},"/groups/{id}/memberships":{"get":{"summary":"List all memberships for a group","description":"List all memberships for a group. Note that Workspace Admins are in two groups: Workspace Admins and Team Admins. The latter contains workspace admins that are also Team Members of the workspace parent team.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the group you want to list the members of","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"Workspace ID for the group","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List all memberships for a group. Note that Workspace Admins are in two groups: Workspace Admins and Team Admins. The latter contains workspace admins that are also Team Members of the workspace parent team.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["groups"],"operationId":"getGroupsIdMemberships"},"post":{"description":"Add user to group (adds to parent workspace if they are not already a member)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the group you wish the user to be added to","type":"integer","format":"int32","required":true},{"name":"postGroupsIdMemberships","in":"body","required":true,"schema":{"$ref":"#/definitions/postGroupsIdMemberships"}}],"responses":{"201":{"description":"Add user to group (adds to parent workspace if they are not already a member)"}},"tags":["groups"],"operationId":"postGroupsIdMemberships"},"delete":{"summary":"Remove a user from a group","description":"Remove a user from a group. Members of the Workspace Admin group may only be removed by other Workspace Admins. If Workspace Admin is Team Member, they may only be removed by another Team Member.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the group you wish the user to be removed from","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"Workspace ID for the group","type":"integer","format":"int32","required":true},{"in":"query","name":"user_id","description":"ID of the user to be removed from this group","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Remove a user from a group. Members of the Workspace Admin group may only be removed by other Workspace Admins. If Workspace Admin is Team Member, they may only be removed by another Team Member."}},"tags":["groups"],"operationId":"deleteGroupsIdMemberships"}},"/organization":{"get":{"summary":"Get organization information","description":"Get organization information","produces":["application/json"],"responses":{"200":{"description":"Get organization information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Organization"}}},"tags":["organization"],"operationId":"getOrganization"},"put":{"summary":"Update organization information","description":"Update organization information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putOrganization","in":"body","required":true,"schema":{"$ref":"#/definitions/putOrganization"}}],"responses":{"200":{"description":"Update organization information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Organization"}}},"tags":["organization"],"operationId":"putOrganization"}},"/organization/support_information":{"put":{"summary":"Update support information of organization","description":"Update support information of organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putOrganizationSupportInformation","in":"body","required":true,"schema":{"$ref":"#/definitions/putOrganizationSupportInformation"}}],"responses":{"200":{"description":"Update support information of organization","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_SupportInformation"}}},"tags":["organization"],"operationId":"putOrganizationSupportInformation"}},"/organization/memberships":{"get":{"summary":"Show all organization members","description":"Show all organization members","produces":["application/json"],"responses":{"200":{"description":"Show all organization members","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["organization"],"operationId":"getOrganizationMemberships"},"post":{"summary":"Add organization admin membership","description":"Add organization admin membership","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postOrganizationMemberships","in":"body","required":true,"schema":{"$ref":"#/definitions/postOrganizationMemberships"}}],"responses":{"201":{"description":"Add organization admin membership","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_OrganizationMembership"}}},"tags":["organization"],"operationId":"postOrganizationMemberships"},"delete":{"summary":"Remove organization admin membership","description":"Remove organization admin membership","produces":["application/json"],"parameters":[{"in":"query","name":"user_id","description":"ID of user to be removed as an organization admin","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Remove organization admin membership"}},"tags":["organization"],"operationId":"deleteOrganizationMemberships"}},"/permissions/folders/{id}":{"get":{"summary":"List subfolder permissions","description":"List subfolder permissions for a group. Will return an array of subfolders under the specified folder, along with their permissions information. For is_mixed_view, is_mixed_download, and is_mixed_upload: if attribute is set to true, it indicates that at least one (but not all) child folder with view, download, or upload attributes set to true, respectively. \"All Folders\" is the parent of all other folders within the workspace; its permissions will be returned if a folder is not specified.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder (0 for root)","type":"integer","format":"int32","required":true},{"in":"query","name":"workspace_id","description":"ID of workspace","type":"integer","format":"int32","required":true},{"in":"query","name":"group_id","description":"ID of group","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List subfolder permissions for a group. Will return an array of subfolders under the specified folder, along with their permissions information. For is_mixed_view, is_mixed_download, and is_mixed_upload: if attribute is set to true, it indicates that at least one (but not all) child folder with view, download, or upload attributes set to true, respectively. \"All Folders\" is the parent of all other folders within the workspace; its permissions will be returned if a folder is not specified.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Permission_FolderList"}}},"tags":["permissions"],"operationId":"getPermissionsFoldersId"},"put":{"summary":"Update folder permissions","description":"Update folder permissions for a group. View = TRUE, this means that group members can return the folder/file and its viewer image. Download = TRUE, this means tha that group members can create download containing the folder. Upload = TRUE, this mean that group members can create an upload object with the folder as a parent.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of folder (0 for root)","type":"integer","format":"int32","required":true},{"name":"putPermissionsFoldersId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPermissionsFoldersId"}}],"responses":{"200":{"description":"Update folder permissions for a group. View = TRUE, this means that group members can return the folder/file and its viewer image. Download = TRUE, this means tha that group members can create download containing the folder. Upload = TRUE, this mean that group members can create an upload object with the folder as a parent.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Permission_FolderUpdate"}}},"tags":["permissions"],"operationId":"putPermissionsFoldersId"}},"/teams":{"get":{"summary":"List all teams in organization","description":"List all teams in organization","produces":["application/json"],"responses":{"200":{"description":"List all teams in organization","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Team"}}},"tags":["teams"],"operationId":"getTeams"},"post":{"summary":"Create team","description":"Create team. Current user will become team owner.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postTeams","in":"body","required":true,"schema":{"$ref":"#/definitions/postTeams"}}],"responses":{"201":{"description":"Create team. Current user will become team owner.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Team"}}},"tags":["teams"],"operationId":"postTeams"}},"/teams/{id}":{"put":{"summary":"Update team","description":"Update team. Includes option to designate a new Team Owner.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of team to update","type":"integer","format":"int32","required":true},{"name":"putTeamsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putTeamsId"}}],"responses":{"200":{"description":"Update team. Includes option to designate a new Team Owner.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Team"}}},"tags":["teams"],"operationId":"putTeamsId"},"get":{"summary":"Get team information","description":"Get team information","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the Team","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get team information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Team"}}},"tags":["teams"],"operationId":"getTeamsId"}},"/teams/{id}/memberships":{"post":{"summary":"Add team member","description":"Add team member","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of team to which user will be added","type":"integer","format":"int32","required":true},{"name":"postTeamsIdMemberships","in":"body","required":true,"schema":{"$ref":"#/definitions/postTeamsIdMemberships"}}],"responses":{"201":{"description":"Add team member","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Membership"}}},"tags":["teams"],"operationId":"postTeamsIdMemberships"},"get":{"summary":"Get list of team members","description":"Get list of team members","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of team for which users will be listed","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get list of team members","schema":{"type":"array","items":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Membership"}}}},"tags":["teams"],"operationId":"getTeamsIdMemberships"},"delete":{"summary":"Remove team member","description":"Remove team member","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of team from which user will be removed","type":"integer","format":"int32","required":true},{"in":"query","name":"user_id","description":"ID of user to remove","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Remove team member"}},"tags":["teams"],"operationId":"deleteTeamsIdMemberships"}},"/teams/{id}/watermark_settings":{"get":{"summary":"List custom watermarks for a team","description":"List custom watermarks for a team","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of team","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List custom watermarks for a team","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting"}}},"tags":["teams"],"operationId":"getTeamsIdWatermarkSettings"}},"/users":{"post":{"summary":"Create user","description":"Create user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postUsers","in":"body","required":true,"schema":{"$ref":"#/definitions/postUsers"}}],"responses":{"201":{"description":"Create user","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["users"],"operationId":"postUsers"},"delete":{"summary":"Delete user","description":"Delete user","produces":["application/json"],"parameters":[{"in":"query","name":"user[id]","description":"ID of the user you want to delete","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete user","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Common_StatusMessage"}}},"tags":["users"],"operationId":"deleteUsers"}},"/users/me":{"put":{"summary":"Update a user","description":"Update a user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putUsersMe","in":"body","required":true,"schema":{"$ref":"#/definitions/putUsersMe"}}],"responses":{"200":{"description":"Update a user","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["users"],"operationId":"putUsersMe"},"get":{"summary":"Get user information","description":"Get user information","produces":["application/json"],"responses":{"200":{"description":"Get user information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["users"],"operationId":"getUsersMe"}},"/users/{id}/remind":{"post":{"summary":"Send reminder to user","description":"Send reminder to user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of user","type":"integer","format":"int32","required":true},{"name":"postUsersIdRemind","in":"body","required":true,"schema":{"$ref":"#/definitions/postUsersIdRemind"}}],"responses":{"201":{"description":"Send reminder to user","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"}}},"tags":["users"],"operationId":"postUsersIdRemind"}},"/user/api_keys":{"get":{"description":"List personal API keys","produces":["application/json"],"responses":{"200":{"description":"List personal API keys"}},"tags":["user"],"operationId":"getUserApiKeys"},"post":{"description":"Create a personal API key","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postUserApiKeys","in":"body","required":true,"schema":{"$ref":"#/definitions/postUserApiKeys"}}],"responses":{"201":{"description":"Create a personal API key"}},"tags":["user"],"operationId":"postUserApiKeys"}},"/user/api_keys/available_scopes":{"get":{"description":"Get available scopes for key creation","produces":["application/json"],"responses":{"200":{"description":"Get available scopes for key creation"}},"tags":["user"],"operationId":"getUserApiKeysAvailableScopes"}},"/user/api_keys/{id}":{"patch":{"description":"Update a personal API key","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true},{"name":"patchUserApiKeysId","in":"body","required":true,"schema":{"$ref":"#/definitions/patchUserApiKeysId"}}],"responses":{"200":{"description":"Update a personal API key"}},"tags":["user"],"operationId":"patchUserApiKeysId"}},"/user/api_keys/{id}/rotate":{"post":{"description":"Rotate a personal API key","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Rotate a personal API key"}},"tags":["user"],"operationId":"postUserApiKeysIdRotate"}},"/watermark":{"post":{"summary":"Add custom watermark","description":"Add custom watermark","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postWatermark","in":"body","required":true,"schema":{"$ref":"#/definitions/postWatermark"}}],"responses":{"201":{"description":"Add custom watermark","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting"}}},"tags":["watermark"],"operationId":"postWatermark"}},"/watermark/{id}":{"get":{"summary":"Get custom watermark setting","description":"Get custom watermark setting","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the watermark setting","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get custom watermark setting","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting"}}},"tags":["watermark"],"operationId":"getWatermarkId"},"put":{"summary":"Update custom watermark","description":"Update custom watermark","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the watermark setting to update","type":"integer","format":"int32","required":true},{"name":"putWatermarkId","in":"body","required":true,"schema":{"$ref":"#/definitions/putWatermarkId"}}],"responses":{"200":{"description":"Update custom watermark","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting"}}},"tags":["watermark"],"operationId":"putWatermarkId"},"delete":{"summary":"Delete custom watermark","description":"Delete custom watermark","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the watermark setting to delete","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete custom watermark","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Common_StatusMessage"}}},"tags":["watermark"],"operationId":"deleteWatermarkId"}},"/workspaces":{"post":{"summary":"Create workspace","description":"Create workspace. Workspace creator will be added to Workspace Admins group.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postWorkspaces","in":"body","required":true,"schema":{"$ref":"#/definitions/postWorkspaces"}}],"responses":{"201":{"description":"Create workspace. Workspace creator will be added to Workspace Admins group.","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Workspace"}}},"tags":["workspaces"],"operationId":"postWorkspaces"},"get":{"summary":"List all workspaces for a team","description":"List all workspaces for a team","produces":["application/json"],"parameters":[{"in":"query","name":"team_id","description":"ID of team from which to list workspaces","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"List all workspaces for a team"}},"tags":["workspaces"],"operationId":"getWorkspaces"}},"/workspaces/{id}":{"get":{"summary":"Get workspace information","description":"Get workspace information","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get workspace information","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Workspace"}}},"tags":["workspaces"],"operationId":"getWorkspacesId"},"put":{"summary":"Update workspace","description":"Update workspace","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of workspace to update","type":"integer","format":"int32","required":true},{"name":"putWorkspacesId","in":"body","required":true,"schema":{"$ref":"#/definitions/putWorkspacesId"}}],"responses":{"200":{"description":"Update workspace","schema":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Workspace"}}},"tags":["workspaces"],"operationId":"putWorkspacesId"}},"/workspaces/{id}/memberships":{"get":{"summary":"Get list of workspace members","description":"Get list of workspace members","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of workspace","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get list of workspace members","schema":{"type":"array","items":{"$ref":"#/definitions/Caplinked_API_V1_Entities_WorkspaceAllMembers"}}}},"tags":["workspaces"],"operationId":"getWorkspacesIdMemberships"}},"/workspaces/{id}/api_access":{"get":{"produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"get ApiAccess(s)"}},"tags":["workspaces"],"operationId":"getWorkspacesIdApiAccess"}},"/workspaces/{id}/api_access/enable":{"post":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"created Enable"}},"tags":["workspaces"],"operationId":"postWorkspacesIdApiAccessEnable"}},"/workspaces/{id}/api_access/disable":{"post":{"produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"created Disable"}},"tags":["workspaces"],"operationId":"postWorkspacesIdApiAccessDisable"}},"/workspaces/{id}/api_access/members":{"get":{"produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"get Member(s)"}},"tags":["workspaces"],"operationId":"getWorkspacesIdApiAccessMembers"}}},"definitions":{"Caplinked_API_V1_Entities_File_FileSearchResult":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"file_name":{"type":"string"},"file_content_type":{"type":"string"},"index":{"type":"integer","format":"int32"},"folder_id":{"type":"integer","format":"int32"},"folder_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","title","file_name","file_content_type","index","folder_id","folder_name","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_File_FileSearchResult model"},"putFilesUpload":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID"},"folder_id":{"type":"integer","format":"int32","description":"Folder ID"},"file_name":{"type":"string","description":"File name"}},"required":["workspace_id","folder_id","file_name"],"description":"Create or update a file with the same file name. Request body should be the file body itself as binary data."},"Caplinked_API_V1_Entities_File_FileInfoCompact":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"file_name":{"type":"string"},"file_size":{"type":"string"},"file_content_type":{"type":"string"},"index":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","title","file_name","file_size","file_content_type","index","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_File_FileInfoCompact model"},"postFilesInfoBatch":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID"},"file_ids":{"type":"array","description":"File Ids","items":{"type":"string"}}},"required":["workspace_id","file_ids"],"description":"Translation missing: en.file.file_info.batch.description"},"Caplinked_API_V1_Entities_File_FileInfoMapped":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"file_name":{"type":"string"},"file_content_type":{"type":"string"},"file_size":{"type":"string"},"index":{"type":"integer","format":"int32"},"folder_id":{"type":"integer","format":"int32"},"pages":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"infected":{"type":"boolean"},"viewer_image":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileViewerImage"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","title","file_name","file_content_type","file_size","index","folder_id","pages","version","infected","viewer_image","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_File_FileInfoMapped model"},"Caplinked_API_V1_Entities_File_FileViewerImage":{"type":"object","properties":{"status":{"type":"string"},"page_number":{"type":"integer","format":"int32"},"expiring_url":{"type":"string"},"expiring_thumbnail_url":{"type":"string"}},"required":["status","page_number","expiring_url","expiring_thumbnail_url"]},"putFilesId":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of workspace"},"file":{"type":"object","properties":{"title":{"type":"string","description":"Title of file"},"index":{"type":"integer","format":"int32","description":"Index number of file within current folder scope (integer)"}}}},"required":["workspace_id","file"],"description":"Update file information"},"Caplinked_API_V1_Entities_File_FileDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"deleted":{"type":"string"}},"required":["id","deleted"],"description":"Caplinked_API_V1_Entities_File_FileDelete model"},"postFilesIdCopy":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of workspace"},"destination_folder_id":{"type":"integer","format":"int32","description":"ID of destination parent folder"}},"required":["workspace_id","destination_folder_id"],"description":"Copy file into another folder (existing file will not be modified)"},"Caplinked_API_V1_Entities_File_FileCopyMove":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"string"}},"required":["message","success"],"description":"Caplinked_API_V1_Entities_File_FileCopyMove model"},"postFilesIdMove":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of workspace"},"destination_folder_id":{"type":"integer","format":"int32","description":"ID of destination parent folder"}},"required":["workspace_id","destination_folder_id"],"description":"Move file into another folder"},"Caplinked_API_V1_Entities_Activity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int32"},"user_name":{"type":"string"},"workspace_id":{"type":"integer","format":"int32"},"verb":{"type":"string"},"message":{"type":"string"},"subject_type":{"type":"string"},"subject_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"}},"required":["id","user_id","user_name","workspace_id","verb","message","subject_type","subject_id","created_at"],"description":"Caplinked_API_V1_Entities_Activity model"},"postDownloads":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of Workspace"},"download":{"type":"object","description":"Parameters of download","properties":{"folder_ids":{"type":"array","description":"IDs of folders to include in download","items":{"type":"integer","format":"int32"}},"file_ids":{"type":"array","description":"IDs of files to include in download","items":{"type":"integer","format":"int32"}}}}},"required":["workspace_id","download"],"description":"Create download object containing folders and/or files"},"Caplinked_API_V1_Entities_Download_Meta":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int32"},"file_ids":{"type":"integer","format":"int32"},"folder_ids":{"type":"integer","format":"int32"},"status":{"type":"string"},"created_at":{"type":"string"}},"required":["id","user_id","file_ids","folder_ids","status","created_at"],"description":"Caplinked_API_V1_Entities_Download_Meta model"},"Caplinked_API_V1_Entities_Download_ExpiringUrl":{"type":"object","properties":{"expiring_url":{"type":"string"},"file_name":{"type":"string"}},"required":["expiring_url","file_name"],"description":"Caplinked_API_V1_Entities_Download_ExpiringUrl model"},"Caplinked_API_V1_Entities_Download_Delete":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"string"}},"required":["id","status"],"description":"Caplinked_API_V1_Entities_Download_Delete model"},"postFolders":{"type":"object","properties":{"workspace_id":{"type":"string","description":"ID of workspace"},"name":{"type":"string","description":"Name of new folder"},"parent_id":{"type":"integer","format":"int32","description":"ID of parent folder (defaults to root folder [id=0])","default":0}},"required":["workspace_id","name"],"description":"Create new folder"},"Caplinked_API_V1_Entities_Folder_FolderMeta":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"path":{"type":"string"},"owner_type":{"type":"string"},"owner_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"index":{"type":"integer","format":"int32"},"last_updated_user_id":{"type":"integer","format":"int32"},"parent_path":{"type":"string"},"parent_id":{"type":"integer","format":"int32"},"id_tree":{"type":"integer","format":"int32"}},"required":["id","name","path","owner_type","owner_id","created_at","updated_at","index","last_updated_user_id","parent_path","parent_id"],"description":"Caplinked_API_V1_Entities_Folder_FolderMeta model"},"Caplinked_API_V1_Entities_Folder_FolderContent":{"type":"object","properties":{"folder":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderMeta"},"immediate_subfolders":{"$ref":"#/definitions/Caplinked_API_V1_Entities_Folder_FolderMeta"},"immediate_subfiles":{"$ref":"#/definitions/Caplinked_API_V1_Entities_File_FileInfoCompact"}},"required":["folder","immediate_subfolders","immediate_subfiles"],"description":"Caplinked_API_V1_Entities_Folder_FolderContent model"},"putFoldersId":{"type":"object","properties":{"workspace_id":{"type":"string","description":"ID of workspace"},"folder":{"type":"object","properties":{"name":{"type":"string","description":"Name of folder"},"index":{"type":"integer","format":"int32","description":"Index number of folder within current folder scope (integer)"}}}},"required":["workspace_id","folder"],"description":"Update folder information"},"Caplinked_API_V1_Entities_Folder_FolderDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"deleted":{"type":"integer","format":"int32"}},"required":["id","deleted"],"description":"Caplinked_API_V1_Entities_Folder_FolderDelete model"},"postFoldersIdCopy":{"type":"object","properties":{"workspace_id":{"type":"string","description":"ID of workspace"},"destination_folder_id":{"type":"integer","format":"int32","description":"ID of destination parent folder"}},"required":["workspace_id","destination_folder_id"],"description":"Copy folder into another folder (existing folder will not be modified). The copied folder will inherit group folder permissions from its new parent folder."},"Caplinked_API_V1_Entities_Folder_FolderCopyMove":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"integer","format":"int32"}},"required":["message","success"],"description":"Caplinked_API_V1_Entities_Folder_FolderCopyMove model"},"postFoldersIdMove":{"type":"object","properties":{"workspace_id":{"type":"string","description":"ID of workspace"},"destination_folder_id":{"type":"integer","format":"int32","description":"ID of destination parent folder"}},"required":["workspace_id","destination_folder_id"],"description":"Move folder into another folder"},"postGroups":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"type":"string","description":"Name of group"},"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"file_managing_abilities":{"type":"boolean","description":"Enable file managing abililies for uploading users","default":false}},"required":["name","workspace_id"]}},"required":["group"],"description":"Create group"},"Caplinked_API_V1_Entities_Group_GroupInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"workspace_id":{"type":"integer","format":"int32"},"drm_enabled":{"type":"boolean"},"drm_expires_after":{"type":"string"},"expire_workspace_access":{"type":"string"},"expire_workspace_access_at":{"type":"string"},"watermarked":{"type":"boolean"},"file_managing_abilities":{"type":"boolean"}},"required":["id","name","workspace_id","drm_enabled","drm_expires_after","expire_workspace_access","expire_workspace_access_at","watermarked","file_managing_abilities"],"description":"Caplinked_API_V1_Entities_Group_GroupInfo model"},"putGroupsId":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"group":{"type":"object","properties":{"name":{"type":"string","description":"Name of group"},"file_managing_abilities":{"type":"boolean","description":"Ability to delete, rename, and reindex files for uploading users","default":false}}}},"required":["workspace_id","group"],"description":"Update group"},"Caplinked_API_V1_Entities_Group_GroupInfoDeleted":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"required":["id","name"],"description":"Caplinked_API_V1_Entities_Group_GroupInfoDeleted model"},"putGroupsIdDrm":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"group":{"type":"object","properties":{"drm_enabled":{"type":"string","description":"Enable DRM for group"},"drm_expires_after":{"type":"string","format":"date","description":"Expire DRM after this date. Format: yyyy-mm-dd"}},"required":["drm_enabled"]}},"required":["workspace_id","group"],"description":"Update DRM for group"},"putGroupsIdDisableDrmExpiration":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"}},"required":["workspace_id"],"description":"Disable DRM expiration for group"},"putGroupsIdWatermarking":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"group":{"type":"object","properties":{"watermarking":{"type":"boolean","description":"Enable watermarking for group"}},"required":["watermarking"]}},"required":["workspace_id","group"],"description":"Watermarking for group"},"putGroupsIdEnableExpireAccess":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"group":{"type":"object","properties":{"expire_workspace_access_at":{"type":"string","format":"date","description":"Expire access on the following date. Format: yyyy-mm-dd"}},"required":["expire_workspace_access_at"]}},"required":["workspace_id","group"],"description":"Enable access expiration for a group"},"putGroupsIdDisableExpireAccess":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"}},"required":["workspace_id"],"description":"Disable access expiration for a group"},"Caplinked_API_V1_Entities_User":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"time_zone":{"type":"string"},"jti":{"type":"string"}},"required":["id","first_name","last_name","email","time_zone","jti"],"description":"Caplinked_API_V1_Entities_User model"},"postGroupsIdMemberships":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"Workspace ID for the group"},"user_id":{"type":"integer","format":"int32","description":"ID of the user to be added to this group"},"email":{"type":"string","description":"Email of the user to be added to this group"},"send_email":{"type":"boolean","description":"Send workspace invitation email to this user.  Defaults to true, use false if you do not want the email to be sent"}},"description":"Add user to group (adds to parent workspace if they are not already a member)"},"Caplinked_API_V1_Entities_Organization":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"billing_email":{"type":"string"},"url":{"type":"string"},"support_number":{"type":"string"},"support_email":{"type":"string"},"support_website":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","description","location","billing_email","url","support_number","support_email","support_website","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_Organization model"},"putOrganization":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization to update"},"description":{"type":"string","description":"Description of the organization to update"},"location":{"type":"string","description":"Location of the organization to update"},"billing_email":{"type":"string","description":"Billing email address of the organization to update"},"url":{"type":"string","description":"Website of the organization to update"}},"description":"Update organization information"},"putOrganizationSupportInformation":{"type":"object","properties":{"phone_number":{"type":"string","description":"Support phone number of the organization to update"},"email":{"type":"string","description":"Support email of the organization to update"},"website":{"type":"string","description":"Support website of the organization to update"}},"description":"Update support information of organization"},"Caplinked_API_V1_Entities_SupportInformation":{"type":"object","properties":{"support_number":{"type":"string"},"support_email":{"type":"string"},"support_website":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["support_number","support_email","support_website","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_SupportInformation model"},"postOrganizationMemberships":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"ID of user to be added as an organization admin"}},"required":["user_id"],"description":"Add organization admin membership"},"Caplinked_API_V1_Entities_OrganizationMembership":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"}},"required":["user_id","created_at"],"description":"Caplinked_API_V1_Entities_OrganizationMembership model"},"Caplinked_API_V1_Entities_Permission_FolderList":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"id_tree":{"type":"integer","format":"int32"},"name":{"type":"string"},"view":{"type":"boolean"},"download":{"type":"boolean"},"upload":{"type":"boolean"},"position":{"type":"integer","format":"int32"},"index":{"type":"integer","format":"int32"},"is_mixed_view":{"type":"boolean"},"is_mixed_download":{"type":"boolean"},"is_mixed_upload":{"type":"boolean"}},"required":["id","id_tree","name","view","download","upload","position","index","is_mixed_view","is_mixed_download","is_mixed_upload"],"description":"Caplinked_API_V1_Entities_Permission_FolderList model"},"putPermissionsFoldersId":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of workspace"},"group_id":{"type":"integer","format":"int32","description":"ID of group"},"verb":{"type":"string","description":"Grant or revoke permission for folder","enum":["grant","revoke"]},"folder_action":{"type":"string","description":"Permission type for folder","enum":["view","download","upload"]}},"required":["workspace_id","group_id","verb","folder_action"],"description":"Update folder permissions for a group. View = TRUE, this means that group members can return the folder/file and its viewer image. Download = TRUE, this means tha that group members can create download containing the folder. Upload = TRUE, this mean that group members can create an upload object with the folder as a parent."},"Caplinked_API_V1_Entities_Permission_FolderUpdate":{"type":"object","properties":{"created_at":{"type":"string"},"updated_at":{"type":"string"},"message":{"type":"string"}},"required":["created_at","updated_at","message"],"description":"Caplinked_API_V1_Entities_Permission_FolderUpdate model"},"Caplinked_API_V1_Entities_Team":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"team_owner_id":{"type":"integer","format":"int32"},"creator_id":{"type":"integer","format":"int32"},"allowed_workspaces":{"type":"integer","format":"int32"},"allowed_admins":{"type":"integer","format":"int32"},"drm_enabled":{"type":"boolean"},"watermarking":{"type":"boolean"},"suppress_emails":{"type":"boolean"}},"required":["id","name","team_owner_id","creator_id","allowed_workspaces","allowed_admins","drm_enabled","watermarking","suppress_emails"],"description":"Caplinked_API_V1_Entities_Team model"},"postTeams":{"type":"object","properties":{"team":{"type":"object","properties":{"name":{"type":"string","description":"Name of the team"},"allowed_workspaces":{"type":"integer","format":"int32","description":"Maximum workspaces for team","default":1},"allowed_admins":{"type":"integer","format":"int32","description":"Maximum number of admins for team","default":10},"drm_enabled":{"type":"boolean","description":"Toggle DRM (feature availability in workspaces)","default":false},"watermarking":{"type":"boolean","description":"Toggle watermarking (feature availability in workspaces)","default":false},"suppress_emails":{"type":"boolean","description":"Toggle email invites","default":true}},"required":["name"]}},"required":["team"],"description":"Create team. Current user will become team owner."},"putTeamsId":{"type":"object","properties":{"team":{"type":"object","properties":{"name":{"type":"string","description":"Name of the team"},"team_owner_id":{"type":"integer","format":"int32","description":"User ID of the team owner"},"allowed_workspaces":{"type":"integer","format":"int32","description":"Maximum workspaces for team"},"allowed_admins":{"type":"integer","format":"int32","description":"Maximum number of admins for team"},"drm_enabled":{"type":"boolean","description":"Toggle DRM (feature availability in workspaces)"},"watermarking":{"type":"boolean","description":"Toggle watermarking (feature availability in workspaces)"},"suppress_emails":{"type":"boolean","description":"Toggle email invites"}}}},"required":["team"],"description":"Update team. Includes option to designate a new Team Owner."},"postTeamsIdMemberships":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32","description":"ID of user to add"},"email":{"type":"string","description":"Email of user to add"}},"description":"Add team member"},"Caplinked_API_V1_Entities_Membership":{"type":"object","properties":{"user":{"$ref":"#/definitions/Caplinked_API_V1_Entities_User"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["created_at","updated_at"],"description":"Caplinked_API_V1_Entities_Membership model"},"Caplinked_API_V1_Entities_UserToken":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"time_zone":{"type":"string"},"user_token":{"type":"string"}},"required":["id","first_name","last_name","email","time_zone","user_token"]},"Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting":{"type":"object","properties":{"watermark_id":{"type":"integer","format":"int32"},"team_id":{"type":"integer","format":"int32"},"custom_text":{"type":"string"},"color":{"type":"string"},"opacity":{"type":"number","format":"float"},"font_size":{"type":"integer","format":"int32"},"rotation":{"type":"integer","format":"int32"},"hposition":{"type":"string"},"vposition":{"type":"string"},"display_user_name":{"type":"boolean"},"display_user_email":{"type":"boolean"},"display_ip_address":{"type":"boolean"},"display_time":{"type":"boolean"},"display_workspace_name":{"type":"boolean"}},"required":["watermark_id","team_id","custom_text","color","opacity","font_size","rotation","hposition","vposition","display_user_name","display_user_email","display_ip_address","display_time","display_workspace_name"],"description":"Caplinked_API_V1_Entities_Watermark_CustomWatermarkSetting model"},"postUsers":{"type":"object","properties":{"user":{"type":"object","properties":{"email":{"type":"string","description":"Email of new user"},"first_name":{"type":"string","description":"First of new user"},"last_name":{"type":"string","description":"Last name of new user"},"time_zone":{"type":"string","description":"Time zone of new user","enum":["International Date Line West","American Samoa","Midway Island","Hawaii","Alaska","Pacific Time (US \u0026 Canada)","Tijuana","Arizona","Mazatlan","Mountain Time (US \u0026 Canada)","Central America","Central Time (US \u0026 Canada)","Chihuahua","Guadalajara","Mexico City","Monterrey","Saskatchewan","Bogota","Eastern Time (US \u0026 Canada)","Indiana (East)","Lima","Quito","Atlantic Time (Canada)","Caracas","Georgetown","La Paz","Puerto Rico","Santiago","Newfoundland","Brasilia","Buenos Aires","Montevideo","Greenland","Mid-Atlantic","Azores","Cape Verde Is.","Edinburgh","Lisbon","London","Monrovia","UTC","Amsterdam","Belgrade","Berlin","Bern","Bratislava","Brussels","Budapest","Casablanca","Copenhagen","Dublin","Ljubljana","Madrid","Paris","Prague","Rome","Sarajevo","Skopje","Stockholm","Vienna","Warsaw","West Central Africa","Zagreb","Zurich","Athens","Bucharest","Cairo","Harare","Helsinki","Jerusalem","Kaliningrad","Kyiv","Pretoria","Riga","Sofia","Tallinn","Vilnius","Baghdad","Istanbul","Kuwait","Minsk","Moscow","Nairobi","Riyadh","St. Petersburg","Volgograd","Tehran","Abu Dhabi","Baku","Muscat","Samara","Tbilisi","Yerevan","Kabul","Almaty","Ekaterinburg","Islamabad","Karachi","Tashkent","Chennai","Kolkata","Mumbai","New Delhi","Sri Jayawardenepura","Kathmandu","Astana","Dhaka","Urumqi","Rangoon","Bangkok","Hanoi","Jakarta","Krasnoyarsk","Novosibirsk","Beijing","Chongqing","Hong Kong","Irkutsk","Kuala Lumpur","Perth","Singapore","Taipei","Ulaanbaatar","Osaka","Sapporo","Seoul","Tokyo","Yakutsk","Adelaide","Darwin","Brisbane","Canberra","Guam","Hobart","Melbourne","Port Moresby","Sydney","Vladivostok","Magadan","New Caledonia","Solomon Is.","Srednekolymsk","Auckland","Fiji","Kamchatka","Marshall Is.","Wellington","Chatham Is.","Nuku'alofa","Samoa","Tokelau Is."]}},"required":["email","first_name","last_name"]}},"required":["user"],"description":"Create user"},"Caplinked_API_V1_Entities_Common_StatusMessage":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"}},"required":["status","message"],"description":"Caplinked_API_V1_Entities_Common_StatusMessage model"},"putUsersMe":{"type":"object","properties":{"user":{"type":"object","properties":{"email":{"type":"string","description":"Email of user to update"},"first_name":{"type":"string","description":"First name of user to update"},"last_name":{"type":"string","description":"Last name of user to update"},"time_zone":{"type":"string","description":"Time zone of user to update","enum":["International Date Line West","American Samoa","Midway Island","Hawaii","Alaska","Pacific Time (US \u0026 Canada)","Tijuana","Arizona","Mazatlan","Mountain Time (US \u0026 Canada)","Central America","Central Time (US \u0026 Canada)","Chihuahua","Guadalajara","Mexico City","Monterrey","Saskatchewan","Bogota","Eastern Time (US \u0026 Canada)","Indiana (East)","Lima","Quito","Atlantic Time (Canada)","Caracas","Georgetown","La Paz","Puerto Rico","Santiago","Newfoundland","Brasilia","Buenos Aires","Montevideo","Greenland","Mid-Atlantic","Azores","Cape Verde Is.","Edinburgh","Lisbon","London","Monrovia","UTC","Amsterdam","Belgrade","Berlin","Bern","Bratislava","Brussels","Budapest","Casablanca","Copenhagen","Dublin","Ljubljana","Madrid","Paris","Prague","Rome","Sarajevo","Skopje","Stockholm","Vienna","Warsaw","West Central Africa","Zagreb","Zurich","Athens","Bucharest","Cairo","Harare","Helsinki","Jerusalem","Kaliningrad","Kyiv","Pretoria","Riga","Sofia","Tallinn","Vilnius","Baghdad","Istanbul","Kuwait","Minsk","Moscow","Nairobi","Riyadh","St. Petersburg","Volgograd","Tehran","Abu Dhabi","Baku","Muscat","Samara","Tbilisi","Yerevan","Kabul","Almaty","Ekaterinburg","Islamabad","Karachi","Tashkent","Chennai","Kolkata","Mumbai","New Delhi","Sri Jayawardenepura","Kathmandu","Astana","Dhaka","Urumqi","Rangoon","Bangkok","Hanoi","Jakarta","Krasnoyarsk","Novosibirsk","Beijing","Chongqing","Hong Kong","Irkutsk","Kuala Lumpur","Perth","Singapore","Taipei","Ulaanbaatar","Osaka","Sapporo","Seoul","Tokyo","Yakutsk","Adelaide","Darwin","Brisbane","Canberra","Guam","Hobart","Melbourne","Port Moresby","Sydney","Vladivostok","Magadan","New Caledonia","Solomon Is.","Srednekolymsk","Auckland","Fiji","Kamchatka","Marshall Is.","Wellington","Chatham Is.","Nuku'alofa","Samoa","Tokelau Is."]}}}},"required":["user"],"description":"Update a user"},"postUsersIdRemind":{"type":"object","properties":{"workspace_id":{"type":"integer","format":"int32","description":"ID of the workspace"}},"required":["workspace_id"],"description":"Send reminder to user"},"postUserApiKeys":{"type":"object","properties":{"api_key":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"scope_type":{"type":"string","enum":["personal","workspace","organization"]},"scope_id":{"type":"integer","format":"int32"},"expires_at":{"type":"string","format":"date-time"},"permissions":{"type":"object"}},"required":["name"]}},"required":["api_key"],"description":"Create a personal API key"},"patchUserApiKeysId":{"type":"object","properties":{"api_key":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"active":{"type":"boolean"}}}},"required":["api_key"],"description":"Update a personal API key"},"postWatermark":{"type":"object","properties":{"team_id":{"type":"integer","format":"int32","description":"ID of the team"},"custom_text":{"type":"string","description":"Custom watermark text"},"color":{"type":"string","description":"Hexadecimal color value (i.e. #eee, #e1e1e1)","default":"#333333"},"opacity":{"type":"number","format":"float","description":"Opacity 0 to 1.0","default":0.5},"font_size":{"type":"integer","format":"int32","description":"Font size in pixels","minimum":2,"maximum":100,"default":18},"rotation":{"type":"integer","format":"int32","description":"Rotation degrees (-90 to 90)","minimum":-90,"maximum":90,"default":0},"hposition":{"type":"string","description":"Horizontal position (left, center, right)","enum":["left","center","right"],"default":"center"},"vposition":{"type":"string","description":"Vertical position (top, center, bottom)","enum":["top","center","bottom"],"default":"center"},"display_user_name":{"type":"boolean","description":"Display user name","default":true},"display_user_email":{"type":"boolean","description":"Display user email address","default":true},"display_ip_address":{"type":"boolean","description":"Display user IP address","default":true},"display_time":{"type":"boolean","description":"Display time","default":true},"display_workspace_name":{"type":"boolean","description":"Display workspace name","default":false}},"required":["team_id","custom_text"],"description":"Add custom watermark"},"putWatermarkId":{"type":"object","properties":{"custom_text":{"type":"string","description":"Custom watermark text"},"color":{"type":"string","description":"Hexadecimal color value (i.e. #eee, #e1e1e1)"},"opacity":{"type":"number","format":"float","description":"Opacity 0 to 1.0"},"font_size":{"type":"integer","format":"int32","description":"Font size in pixels","minimum":2,"maximum":100},"rotation":{"type":"integer","format":"int32","description":"Rotation degrees (-90 to 90)","minimum":-90,"maximum":90},"hposition":{"type":"string","description":"Horizontal position (left, center, right)","enum":["left","center","right"]},"vposition":{"type":"string","description":"Vertical position (top, center, bottom)","enum":["top","center","bottom"]},"display_user_name":{"type":"boolean","description":"Display user name"},"display_user_email":{"type":"boolean","description":"Display user email address"},"display_ip_address":{"type":"boolean","description":"Display user IP address"},"display_time":{"type":"boolean","description":"Display time"},"display_workspace_name":{"type":"boolean","description":"Display workspace name"}},"description":"Update custom watermark"},"postWorkspaces":{"type":"object","properties":{"team_id":{"type":"integer","format":"int32","description":"ID of parent team for this workspace"},"workspace":{"type":"object","properties":{"name":{"type":"string","description":"Name of workspace to create"}},"required":["name"]}},"required":["team_id","workspace"],"description":"Create workspace. Workspace creator will be added to Workspace Admins group."},"Caplinked_API_V1_Entities_Workspace":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"team_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","name","team_id","created_at","updated_at"],"description":"Caplinked_API_V1_Entities_Workspace model"},"putWorkspacesId":{"type":"object","properties":{"workspace":{"type":"object","properties":{"name":{"type":"string","description":"Name of workspace to update"}}}},"required":["workspace"],"description":"Update workspace"},"Caplinked_API_V1_Entities_WorkspaceAllMembers":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"workspace_id":{"type":"integer","format":"int32"},"status":{"type":"string"},"admin":{"type":"boolean"},"last_accessed":{"type":"string"}},"required":["user_id","first_name","last_name","email","workspace_id","status","admin","last_accessed"],"description":"Caplinked_API_V1_Entities_WorkspaceAllMembers model"}}}