Scannable Docs
Concepts

Folders

How folders hold your equipment, and who can see them.

A folder (folder_…) is a place you keep equipment: a kit bag, a location, a vehicle, a client, a member of staff or an equipment type. Folders nest, so a depot can hold bays and a bay can hold kit bags. Each folder names the folder it sits in as parent, { id, name }, or null at the top level.

List folders with List folders and read one with Retrieve a folder. Without parent the list holds every folder; pass a folder's id as parent for the folders directly inside it, or parent=none for the top level.

Who can see a folder

What a person sees in Scannable depends on their role and on the folder's permissions: the members and teams granted that folder.

RoleUnrestricted folderRestricted folder
AdminSees itSees it
Manager, MemberSees itNeeds a permission
User, SupplierNeeds a permissionNeeds a permission

A folder is restricted when it, or any folder above it, is restricted.

A folder's permissions list the members (member) and teams (team) with a permission on it, each as { id, name }. Each one is either:

  • explicit, set on this folder, or
  • inherited, set on a folder above it, named by from_folder_id. Permissions are inherited down to the nearest restricted folder: restricting a folder starts its permissions afresh.

A team permission covers everyone in the team; look them up with the team's members. Admins see every folder and are never listed.

Turning restriction off keeps a folder's permissions. They still decide what Users and Suppliers see, so the list shows them whether or not the folder is restricted.

What an API key sees

An API key sees every folder in your organisation, restricted ones included, whatever its creator's role. Permissions tell you who can see a folder in Scannable; they do not limit the key.

On this page