Do not input private or sensitive data. View Qlik Privacy & Cookie Policy.
Skip to main content

Announcements
Qlik Open Lakehouse is Now Generally Available! Discover the key highlights and partner resources here.
cancel
Showing results for 
Search instead for 
Did you mean: 
Wojciech_Mokwinski
Contributor II
Contributor II

How to get the list of all apps to which we have access to by using qlik-api's getDocList() method?

We are transitioning from an old implementation of our React app using Capability APIs to a new implementation using qlik-embed + qlik-api. In our legacy system, we had a crucial feature that loaded the list of all Qlik applications to which the user has access. In our old application in the solution with Capability APIs, we downloaded the entire list of applications to which we have access from .../qrs/app/hublist endpoint.

Can we somehow get a list of all the applications we have access to in the new implementation with qlik-embed + qlik-api? How to use getDocList() method from the qlik-api?

I tried to use the getDocsList method with qlik-api, however I do not know how to implement this method correctly and there are limited resources on the Internet showing how to invoke this method. Now, I only managed to get a list of applications from a specific application using getSheetList() method. The main problem is that I do not know what is the "global" object in the docs which calls this method. It is not specified enough. Also, there is few resources about this method outside the docs.

I tried invoking it doing it similarly to getting the SheetList from specific app: Obtain a list of sheets from an analytics app | Qlik Developer Portal

By invoking it by qix, hostConfig, session or app I got nothing more that the "function does not exist" error.

Thank you in advance for your help!

2 Solutions

Accepted Solutions
Øystein_Kolsrud
Employee
Employee

I would say the recommended way to do this is to use the "items" REST endpoint:

https://qlik.dev/apis/rest/items/

That is also closer to what you did to with the "hublist" endpoint for the on-prem product. Here's another thread on the same topic:

https://community.qlik.com/t5/Integration-Extension-APIs/List-of-all-apps-using-Qlik-SaaS-Rest-API/t...

View solution in original post

Øystein_Kolsrud
Employee
Employee

Oh... Sorry, I misunderstood the context here. But if you're on the on-prem version, then why don't you simply continue to use the "/qrs/app/hublist" endpoint?

I would avoid "GetDocList" if I were you. The QRS endpoints provides a lot more flexibility when it comes to filtering and sorting and stuff. And especially for large deployments, the "fetch all" method can be problematic as it can risk causing performance issues due to rule evaluations.

But if you want to proceed with using "GetDocList", then there is an example here that illustrates how that endpoint works. It's pretty basic. Just call it (no arguments or anything) on the global object and you get a (potentially long) list of app infos back:

https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineAPI/Content/Sense_EngineAPI/Cre...

 

View solution in original post

4 Replies
Øystein_Kolsrud
Employee
Employee

I would say the recommended way to do this is to use the "items" REST endpoint:

https://qlik.dev/apis/rest/items/

That is also closer to what you did to with the "hublist" endpoint for the on-prem product. Here's another thread on the same topic:

https://community.qlik.com/t5/Integration-Extension-APIs/List-of-all-apps-using-Qlik-SaaS-Rest-API/t...

Wojciech_Mokwinski
Contributor II
Contributor II
Author

Unfortunately we are not using Qlik Cloud. Could REST APIs still work in solution using Qlik Sense Enterprise Client Managed?

Link for reference:
 REST APIs | Qlik Developer Portal

Øystein_Kolsrud
Employee
Employee

Oh... Sorry, I misunderstood the context here. But if you're on the on-prem version, then why don't you simply continue to use the "/qrs/app/hublist" endpoint?

I would avoid "GetDocList" if I were you. The QRS endpoints provides a lot more flexibility when it comes to filtering and sorting and stuff. And especially for large deployments, the "fetch all" method can be problematic as it can risk causing performance issues due to rule evaluations.

But if you want to proceed with using "GetDocList", then there is an example here that illustrates how that endpoint works. It's pretty basic. Just call it (no arguments or anything) on the global object and you get a (potentially long) list of app infos back:

https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineAPI/Content/Sense_EngineAPI/Cre...

 

Wojciech_Mokwinski
Contributor II
Contributor II
Author

It worked, thank you very much!