Skip to main content

Get folder

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 its id from listFolders or createFolder.

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. null for a folder at the top level.
  • permission (string or null, required): What you can do in the folder: view, edit or manage, as in listFolders. manage when you own it. null when you see it only because a report in it is shared with you. One of view, 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 their id in listMembers.
    • 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 has manage. One of view, edit, manage.
    • source (string, required): owner for the member who owns the folder, direct when it is shared with them, folder when they reach it through a folder it is nested in, which unshareFolder on this folder leaves as it is. One of owner, direct, folder.
    • folder (string): With folder: the name of the parent folder they reach it through, when you can see that folder.