Retrieve effective hidden status via API
under review
F
Famous Newt
Currently, the API returns a hidden attribute when retrieving the settings for categories or articles which is based on the hidden status of the particular category/article. However, sometimes you just hide a category on a higher level and rely that all children inherit that setting implicitly and are hidden automatically.
We would like to somehow get an "effective" hidden status via the API that reflects if an article is generally hidden on the site, either because it is set hidden directly or because one of its direct parent categories is set to hidden.
Log In
Mohamed Shakheen
marked this post as
under review
Mohamed Shakheen
Hi Famous Newt
Thank you for sharing the requirement.
Currently, the API returns the hidden attribute only based on the direct visibility setting applied to the specific category or article. It does not evaluate or return the inherited visibility status from parent categories.
In scenarios where a parent category is marked as hidden, the child categories and articles are effectively hidden on the site through inheritance. However, this inherited state is not reflected in the API response, as the API only returns the explicit configuration of the individual item.
At this moment, the API does not provide an “effective hidden status” that considers both the direct hidden setting and the inherited hidden status from parent categories.
We understand the value of having an API field that reflects whether an article or category is effectively hidden on the site, regardless of whether it is hidden directly or through a parent category. We will review this requirement internally to evaluate the feasibility of exposing such a field in the API.
We will keep you informed once we have further updates on this.