Navigation Menu

Get project files

GET /api/2.0/project/{id:[0-9]+}/files

Request

Returns the detailed list of all the files and folders for the project with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

Project ID

Examples

GET /api/2.0/project/%7Bid:[0-9]+%7D/files HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/project/%7Bid:[0-9]+%7D/files' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Project files

Filesarray of object
Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring
Foldersarray of object
ParentIdobject
FilesCountintegerformat: int32
FoldersCountintegerformat: int32
IsShareableboolean
IsFavoriteboolean
Idobject
Titlestring
Accessenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter.

Sharedboolean
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
RootFolderTypeenum of integerformat: int32

[0 - DEFAULT, 1 - COMMON, 2 - BUNCH, 3 - TRASH, 5 - USER, 6 - SHARE, 8 - Projects, 10 - Favorites, 11 - Recent, 12 - Templates, 13 - Privacy]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy.

UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ProviderItemboolean
ProviderKeystring
ProviderIdintegerformat: int32
DenyDownloadboolean
DenySharingboolean
Currentobject
ParentIdobject
FilesCountintegerformat: int32
FoldersCountintegerformat: int32
IsShareableboolean
IsFavoriteboolean
Idobject
Titlestring
Accessenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter.

Sharedboolean
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
RootFolderTypeenum of integerformat: int32

[0 - DEFAULT, 1 - COMMON, 2 - BUNCH, 3 - TRASH, 5 - USER, 6 - SHARE, 8 - Projects, 10 - Favorites, 11 - Recent, 12 - Templates, 13 - Privacy]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy.

UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ProviderItemboolean
ProviderKeystring
ProviderIdintegerformat: int32
DenyDownloadboolean
DenySharingboolean
PathPartsobject
StartIndexintegerformat: int32
Countintegerformat: int32
Totalintegerformat: int32
Newintegerformat: int32

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).