List folders
list_folders
Lists the folders in a workspace with the name, slug, position, creator and a stored count of the sites in each.
Scopesites:readRead only
Folders group sites in the dashboard. A site sits in at most one, and a folder only ever holds sites from its own workspace. The folders come back in their dashboard order, and the built-in Archive is not a folder, so it is not listed.
The site count is stored rather than counted on each call, and it leaves out deleted sites, so treat it as an indication rather than a live total.
Start here before moving anything, because rename_folder, update_folder_slug, move_sites_to_folder, reorder_folders, delete_folder and move_folder_to_workspace all take a folder id from this list. See Folders.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
workspaceId |
string | Yes | The workspace id, from list_workspaces. |