Skip to main content

List folders

GET https://api.rollstack.com/public/v1/folders

The folders the user can see, each with its parent, null at the top level, and the user's permission on it: null, view, edit or manage. Pass a folder's id as folderId to listReports or createReport, or to getFolder to see who it's shared with.

Requires the slide_decks:read scope.

Operation ID: listFolders.

Response 200

Success

application/json: array of object

  • id (string, required): Unique identifier for the folder. Pass it as folderId to listReports to list the reports in it, or to createReport or updateReport to put a report in it.
  • 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. The parent is missing from the list when you can see this folder but not its parent.
  • permission (string or null, required): What you can do in the folder. view lets you open the reports in it, edit also lets you change them, and manage also lets you share the folder and change who has access to it. It is the highest of what the folder is shared with you directly and what you get from the folders it is nested in, where owning one of those gives manage. null when you own the folder and get nothing from a parent folder, as with a top-level folder you created: as its owner, you can do everything in it. One of view, edit, manage.