# API reference for Windows

The following API reference is for Qlik Sense Enterprise on Windows only.

Information note**Interested in Qlik Cloud APIs?**

Check out the API reference documentation in the site [Qlik Developer](https://qlik.dev/) instead.

## Building mashups and custom visualization objects

Use these resources to build and bring capabilities into visualization extensions, and mashups.

Information note

If you're planning to use capability APIs to embed Qlik into your web apps or mashups, consider using Qlik's primary embedding framework, [qlik-embed](https://qlik.dev/embed/qlik-embed/).

For building custom visualizations or extensions, consider using the [nebula.js](https://qlik.dev/extend/set-up-nebula-environment) collection of JavaScript libraries, visualizations, and CLIs that help developers build and integrate visualizations on top of Qlik's Associative Engine.

| API name | API type | Visualization extensions | Widgets | Custom components | Mashups |
| --- | --- | --- | --- | --- | --- |
| [Engine JSON API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/EngineJSONAPI/Content/introduction.htm) | JSON RPC | Yes | No | No | Yes |
| [Extension API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/extensions-api-reference.htm) | JavaScript library | Yes | No | No | No |
| [Backend API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/backend-api-reference.htm) | JavaScript library | Yes | No | No | No |
| [Root API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-interface-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [App API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-app-interface.htm) | JavaScript library (Capability API) | Yes | Yes | Yes | Yes |
| [Bookmark API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-bookmark-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [Field API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-field-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [Global API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-global-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [Navigation API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/NavigationAPI/NavigationAPI.htm) | JavaScript library (Capability API) | Yes | Yes | Yes | No |
| [Selection API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/SelectionAPI/qlik-selectionState-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [Table API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/TableAPI/qlik-table-interface.htm) | JavaScript library (Capability API) | Yes | Yes | Yes | Yes |
| [Theme API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/ThemeAPI/ThemeAPI.htm) | JavaScript library (Capability API) | No | No | No | Yes |
| [Variable API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/qlik-variable-interface.htm) | JavaScript library (Capability API) | Yes | No | Yes | Yes |
| [Visualization API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/CapabilityAPIs/VisualizationAPI/VisualizationAPI.htm) | JavaScript library (Capability API) | No | No | No | Yes |
| [App Integration API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/app-integration-api.htm) | URL integration | No | No | No | Yes |
| [Single Integration API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/single-integration-api.htm) | URL integration | No | No | No | Yes |
| [qlik-visual](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/QlikVisual/qlik-visual.htm) | Web component | No | Yes | No | Yes |
| [enigma.js](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/enigmajs/enigmajs-introduction.htm) | JavaScript library (Open Source) | Yes | No | Yes | Yes |
| [enigma-go](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/enigmago/enigmago-introduction.htm) | Go library (Open Source) | Yes | No | Yes | Yes |
| [leonardo-ui](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/leonardo-ui/leonardoui-introduction.htm) | UI library (Open Source) | Yes | Yes | Yes | Yes |
| [picasso.js](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/APIs/Content/Sense_ClientAPIs/picassojs/picassojs-introduction.htm) | JavaScript library (Open Source) | Yes | No | Yes | Yes |

## Building connectors

Use the QVX SDK to build customized connectors, used to retrieve data from data sources not supported by a generic Qlik Sense installation.

[QVX SDK](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/QVXSDKAPI/Content/Sense_QVXSDKAPI/Reference.htm)

## Building Windows applications

Use the .NET SDK to integrate Qlik Sense in your own Windows (.NET) applications.

[.NET SDK](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/NetSDKAPIref/Content/Home.htm)

## Managing and automating administrative jobs

Use the REST APIs to manage data, configuration information and authentication.

[Proxy Service API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/ProxyServiceAPI/Content/Sense_ProxyServiceAPI/ProxyServiceAPI-Introduction.htm)

[Repository Service API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/RepositoryServiceAPI/Content/Sense_RepositoryServiceAPI/RepositoryServiceAPI-Reference-Redirect.htm)

## Retrieving information about the product

Use the REST API to retrieve product information including details about the system, components, external URLs, and third-party software.

[About Service API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/AboutServiceAPI/Content/Sense_AboutServiceAPI/AboutServiceAPI-Introduction.htm)

## Creating on-demand apps

Use the REST API to create on-demand apps by accessing the ODAG Service API.

[ODAG Service API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/ODAGserviceAPI/Content/Home.htm)

## Importing users and groups

Use the .NET API to import users and groups in Qlik Sense.

[User Directory Connector API](https://help.qlik.com/en-US/sense-developer/May2026/Subsystems/UserDirectoryConnectorAPI/Content/Sense_UserDirectoryConnectorAPI/UDCAPI-Introduction.htm)

## Checking the health of Qlik services

The following API endpoints are available for service health checks. Use the HTTP GET method to call the API endpoint. If the service is running correctly, you should receive a 200 status code.

| Service | API endpoint |
| --- | --- |
| Qlik Repository | https://{QSE\_domain}/qrs/about |
| Qlik Proxy | https://{QSE\_domain}:4243/qps/alive |
| Qlik Engine | https://{QSE\_domain}:4747/healthcheck (or https://{QSE\_domain}/engine/healthcheck) |
| Qlik Scheduler | https://{QSE\_domain}:5050/qss/alive (Use port 5151 for slave scheduler) |
| Qlik Printing | https://{QSE\_domain/printing/alive |