Get folder
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
GET https://api.rollstack.com/public/v1/folders/{id}
A folder the user can see, with its parent and everyone who has access to it: its owner, the members it is shared with directly, and those who reach it through the folder it is nested in, each with their permission.
Requires the slide_decks:read scope.
Operation ID: getFolder.
Path parameters
id(string, required): The folder to act on, by itsidfromlistFoldersorcreateFolder.
Response 200
Success
application/json
id(string, required): Unique identifier for the folder.name(string, required): The folder's name, as shown in Rollstack.parentFolderId(string or null, required): The folder this one is nested in.nullfor a folder at the top level.permission(string or null, required): What you can do in the folder:view,editormanage, as inlistFolders.managewhen you own it.nullwhen you see it only because a report in it is shared with you. One ofview,edit,manage.access(array of object, required): Everyone with access to the folder, the owner first.userId(number, required): The member's user id, the same as theiridinlistMembers.name(string, required): The member's name, as shown in Rollstack.email(string, required): The member's email address.permission(string, required): What they can do in the folder. The owner hasmanage. One ofview,edit,manage.source(string, required):ownerfor the member who owns the folder,directwhen it is shared with them,folderwhen they reach it through a folder it is nested in, whichunshareFolderon this folder leaves as it is. One ofowner,direct,folder.folder(string): Withfolder: the name of the parent folder they reach it through, when you can see that folder.