Skip to content

folder-list.mdx

Latest commit

 

History

History
120 lines (89 loc) · 2.76 KB

folder-list.mdx

File metadata and controls

120 lines (89 loc) · 2.76 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

spo folder list

Returns all folders under the specified parent folder

Usage

m365 spo folder list [options]

Options

`-u, --webUrl <webUrl>`
: The URL of the site where the folders to list are located.

`-p, --parentFolderUrl <parentFolderUrl>`
: The server- or site-relative decoded URL of the parent folder.

`--fields [fields]`
: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.

`--filter [filter]`
: OData filter to use to query the list of folders with.

`-r, --recursive`
: Set to retrieve nested folders.

Examples

Gets list of folders under a parent folder with site-relative URL.

m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'

Gets recursive list of folders under a specific folder on a specific site.

m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive

Return a filtered list of folders and only return the list item ID.

m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter "startswith(Name,'Folder')"

Response

[  
  {
    "Exists": true,
    "IsWOPIEnabled": false,
    "ItemCount": 9,
    "Name": "Folder A",
    "ProgID": null,
    "ServerRelativeUrl": "/sites/project-x/Shared Documents/Folder A",
    "TimeCreated": "2022-04-26T12:30:56Z",
    "TimeLastModified": "2022-04-26T12:50:14Z",
    "UniqueId": "20523746-971b-4488-aa6d-b45d645f61c5",
    "WelcomePage": ""
  }
]
Name      ServerRelativeUrl
--------  ------------------------------------------
Folder A  /sites/project-x/Shared Documents/Folder A

Name,ServerRelativeUrl
Folder A,/sites/project-x/Shared Documents/Folder A
# spo folder list --webUrl "https://contoso.sharepoint.com" --parentFolderUrl "/Shared Documents"

Date: 29/3/2023

## Folder A (20523746-971b-4488-aa6d-b45d645f61c5)

Property | Value
---------|-------
Exists | true
IsWOPIEnabled | false
ItemCount | 9
Name | Folder A
ProgID | null
ServerRelativeUrl | /sites/project-x/Shared Documents/Folder A
TimeCreated | 2022-04-26T12:30:56Z
TimeLastModified | 2022-04-26T12:50:14Z
UniqueId | 20523746-971b-4488-aa6d-b45d645f61c5
WelcomePage |