Submit Feedback
Legacy Knowledge Base
Published Sep. 10, 2025

Is it Possible to Access the Entire Document Hierarchy Page with API?

Written By

Lucas Mesquita

How To articles are not official guidelines or officially supported documentation. They are community-contributed content and may not always reflect the latest updates to Liferay DXP. We welcome your feedback to improve How To articles!

While we make every effort to ensure this Knowledge Base is accurate, it may not always reflect the most recent updates or official guidelines.We appreciate your understanding and encourage you to reach out with any feedback or concerns.

Legacy Article

You are viewing an article from our legacy "FastTrack" publication program, made available for informational purposes. Articles in this program were published without a requirement for independent editing or verification and are provided"as is" without guarantee.

Before using any information from this article, independently verify its suitability for your situation and project.

Issue

  • How to access the entire document hierarchy page using API?

Environment

  • All environments

Resolution

  • By default, the GET Documents call in the Liferay API restricts access to the root page, preventing retrieval of the complete document hierarchy. To access the entire document hierarchy lies in incorporating the recursive=true parameter into the GET request for the /documents endpoint.
  • A possible example to achieve the desired behavior is to include the following API call:
    GET /headless-delivery/v1.0/sites/{siteId}/documents?flatten=true&recursive=true
  • Replace {siteId} with the ID of the desired site.
  • The flatten=true parameter presents the documents in a flat structure, simplifying navigation.
  • The recursive=true parameter ensures the query encompasses the entire folder hierarchy.

Additional Information

 

Did this article resolve your issue ?
Legacy Knowledge Base
Did this article resolve your issue ?