Returns the detailed list of files and folders located in the "My documents" section.
Name | Description | Type | Example |
userIdOrGroupId
sent in url
|
User or group ID
optional
|
guid | 9924256A-739C-462b-AF15-E652A3B1B6EB |
filterType
sent in url
|
Filter type
optional
|
None, FilesOnly, FoldersOnly, DocumentsOnly, PresentationsOnly, SpreadsheetsOnly, ImagesOnly, ByUser, ByDepartment, ArchiveOnly, ByExtension, MediaOnly | None |
searchInContent
sent in url
|
Specifies whether to search within the section contents or not | Bool value | true |
extension
sent in url
|
File extension by which files will be searched for if the FilterType.ByExtension parameter is passed | string | some text |
withSubfolders
sent in url
|
Specifies whether to return sections with or without subfolders | Bool value | true |
GET api/2.0/files/@my Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json { "userIdOrGroupId": "9924256A-739C-462b-AF15-E652A3B1B6EB", "filterType": "None", "searchInContent": true, "extension": "some text", "withSubfolders": true }
The "My documents" section contents
application/json
{ "status": 0, "response": { "Files": [ { "RootFolderType": 2, "UpdatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Created": "2020-12-13T17:13:31.5902727Z", "CreatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Updated": "2020-12-13T17:13:31.5902727Z", "ProviderItem": true, "ProviderKey": "1234d", "ProviderId": 1234, "FolderId": 12334, "Version": 3, "VersionGroup": 1, "ContentLength": "12.06 KB", "PureContentLength": 12345, "FileStatus": 2, "ViewUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221", "WebUrl": "http:\\/\\/www.onlyoffice.com\\/viewfile?fileid=2221", "FileType": 7, "FileExst": ".txt", "Comment": null, "Encrypted": true, "Id": 857864274, "Title": "Some titile.txt", "Access": 1, "Shared": false } ], "Folders": [ { "RootFolderType": 2, "UpdatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Created": "2020-12-13T17:13:31.5902727Z", "CreatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Updated": "2020-12-13T17:13:31.5902727Z", "ProviderItem": true, "ProviderKey": "1234d", "ProviderId": 1234, "ParentId": 1840746475, "FilesCount": 1840746475, "FoldersCount": 1840746475, "IsShareable": true, "Id": 857864274, "Title": "Some titile.txt", "Access": 1, "Shared": false } ], "Current": { "RootFolderType": 2, "UpdatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Created": "2020-12-13T17:13:31.5902727Z", "CreatedBy": { "Id": "00000000-0000-0000-0000-000000000000", "DisplayName": "Mike Zanyatski", "Title": "Manager", "AvatarSmall": "url to small avatar", "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator" }, "Updated": "2020-12-13T17:13:31.5902727Z", "ProviderItem": true, "ProviderKey": "1234d", "ProviderId": 1234, "ParentId": 1840746475, "FilesCount": 1840746475, "FoldersCount": 1840746475, "IsShareable": true, "Id": 857864274, "Title": "Some titile.txt", "Access": 1, "Shared": false }, "StartIndex": 0, "Count": 4, "Total": 4 } }
text/xml
<result> <status>0</status> <response> <Files> <RootFolderType>2</RootFolderType> <UpdatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </UpdatedBy> <Created>2020-12-13T17:13:31.5902727Z</Created> <CreatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </CreatedBy> <Updated>2020-12-13T17:13:31.5902727Z</Updated> <ProviderItem>True</ProviderItem> <ProviderKey>1234d</ProviderKey> <ProviderId>1234</ProviderId> <FolderId>12334</FolderId> <Version>3</Version> <VersionGroup>1</VersionGroup> <ContentLength>12.06 KB</ContentLength> <PureContentLength>12345</PureContentLength> <FileStatus>2</FileStatus> <ViewUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</ViewUrl> <WebUrl>http:\/\/www.onlyoffice.com\/viewfile?fileid=2221</WebUrl> <FileType>7</FileType> <FileExst>.txt</FileExst> <Comment /> <Encrypted>True</Encrypted> <Id>857864274</Id> <Title>Some titile.txt</Title> <Access>1</Access> <Shared>False</Shared> </Files> <Folders> <RootFolderType>2</RootFolderType> <UpdatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </UpdatedBy> <Created>2020-12-13T17:13:31.5902727Z</Created> <CreatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </CreatedBy> <Updated>2020-12-13T17:13:31.5902727Z</Updated> <ProviderItem>True</ProviderItem> <ProviderKey>1234d</ProviderKey> <ProviderId>1234</ProviderId> <ParentId>1840746475</ParentId> <FilesCount>1840746475</FilesCount> <FoldersCount>1840746475</FoldersCount> <IsShareable>True</IsShareable> <Id>857864274</Id> <Title>Some titile.txt</Title> <Access>1</Access> <Shared>False</Shared> </Folders> <Current> <RootFolderType>2</RootFolderType> <UpdatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </UpdatedBy> <Created>2020-12-13T17:13:31.5902727Z</Created> <CreatedBy> <Id>00000000-0000-0000-0000-000000000000</Id> <DisplayName>Mike Zanyatski</DisplayName> <Title>Manager</Title> <AvatarSmall>url to small avatar</AvatarSmall> <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl> </CreatedBy> <Updated>2020-12-13T17:13:31.5902727Z</Updated> <ProviderItem>True</ProviderItem> <ProviderKey>1234d</ProviderKey> <ProviderId>1234</ProviderId> <ParentId>1840746475</ParentId> <FilesCount>1840746475</FilesCount> <FoldersCount>1840746475</FoldersCount> <IsShareable>True</IsShareable> <Id>857864274</Id> <Title>Some titile.txt</Title> <Access>1</Access> <Shared>False</Shared> </Current> <StartIndex>0</StartIndex> <Count>4</Count> <Total>4</Total> </response> </result>