How can we help you today?

How to Show Only the Folders of your Document Library Using REST API

This article demonstrates how to use the REST API connection to display only the folders from a Document Library.


sample file list

NOTEIf you want to showcase both folders and files, check out the following articles:
>How to Show a Mixed View of Files and Folders from a Document Library Using REST API
>How to Show Both Files and Folders of the Document Library in a ShortPoint Element
>How to Show Top-Level Folders and Files from a Document Library Using REST API

TABLE OF CONTENTS


Prerequisites

  • You must have the latest version of ShortPoint SPFx installed on your SharePoint environment.
  • You must be a ShortPoint Designer with an active license.
  • You must have an existing File List Design Element.
  • You must have an existing Document Library with folders. To learn how to create a Document Library, check out Create a Document Library in SharePoint.


sample document library


Step-by-step Tutorial

Follow the steps below to get started:


Step 1: Edit the ShortPoint Web Part

Go to the SharePoint page you want to use and click Edit:


Edit


Close the Toolbox:


close icon


Click the Edit properties icon:


Edit properties icon


Step 2: Switch to Grid Mode

NOTEShortPoint Connect is currently only available in Grid Mode.


Click the Switch to Grid Mode icon:


Switch to Grid Mode icon


Step 3: Copy and Prepare the REST API URL

NOTEBefore proceeding, you must already have an existing Document Library with folders and files. To learn how to create a Document Library, check out Create a Document Library in SharePoint. 

sample document library


Copy the REST API URL that fits your needs:

  • If you are using the root site collection and the root site document library:


https://tenant url/sites/site collection name/_api/web/GetFolderByServerRelativeUrl('/Library Name')/Folders?$filter=not substringof('/Forms', ServerRelativeUrl)


  • If you are using a different site collection and its document library:


https://tenant url/sites/site collection name/_api/web/GetFolderByServerRelativeUrl('/sites/site collection name/Library Name')/Folders?$filter=not substringof('/Forms', ServerRelativeUrl)


Substitute the items highlighted in red with your actual website URL and Document Library name. Here is an example of what the URL could look like:


https://yoursite.sharepoint.com/sites/marketingmaterials/_api/web/GetFolderByServerRelativeUrl('/Guide')/Folders?$filter=not substringof('/Forms', ServerRelativeUrl)


Step 4: Edit the File List Design Element

NOTEBefore proceeding, make sure you already have the File List Design Element on your page:

file list design element

Hover over the File List and select the cogwheel icon:


Cogwheel icon


Step 5: Paste the REST API URL and Connect

Switch to the Connect tab:


Connect tab


Select REST API:


REST API


Paste the REST API URL you prepared in Step 3 in the field provided:


paste


Click Connect:


Connect


Step 6: Map Items

Switch to the Items tab:


Items tab


Delete all default content:


delete default content


Use the link icon to map what will be displayed as the Title, Subtitle, and Description. In our example, we will showcase the folder name as the title, the date created as the subtitle, and leave the description blank:


map items


NOTEYou can customize what information appears in the Title, Subtitle, and Description fields. Feel free to use our example or choose your own preferred display options.

Set  #ServerRelativeUrl as the Link:


link


Scroll down until you see the icon field and set any folder icon as the default icon:


icon


Step 7: Preview and Save

Select Preview to see how the list will look:


Preview


Once satisfied, click Update:


Update


Click the eye icon to see your page in real-time:


eye icon


Click Save to apply all your changes:


Save


That’s it! Your Document Library folders are now shown in your SharePoint page.


Related articles:


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

World's best intranet sites are designed using ShortPoint

Get started today! Learn more
See all 33 topics

Start a trial

Ignite your vision. Install ShortPoint directly on your site, or play in sandbox mode. No credit card required.

Get started today

World’s best intranet sites are designed using ShortPoint

Thousands of companies using ShortPoint everyday to design, brand and build award winning intranet sites.

Get started Learn more