Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sense Enterprise Custom Property API

Manage custom properties for tagging and categorizing entities

Qlik Sense Enterprise Custom Property API is one of 32 APIs that Qlik Sense Enterprise publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Property. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2025.11.0.

Requests are made against a single base URL, https://{server}/api/about/v1.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2025.11.0
Server
https://{server}/api/about/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qlik Sense Enterprise Custom Property API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Qlik-Xrfkey (xrfkey). By default, every request must be authenticated.

  • xrfkey — Cross-site request forgery prevention key. Must be 16 arbitrary characters and must match the Xrfkey query parameter.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Property 5

Manage custom properties for tagging and categorizing entities

GET
/customproperty
Qlik Sense Enterprise List custom properties
getCustomProperties 3 params → 200401
POST
/customproperty
Qlik Sense Enterprise Create custom property
createCustomProperty 1 param body → 201400401
GET
/customproperty/{id}
Qlik Sense Enterprise Get custom property by ID
getCustomProperty 2 params → 200404401
PUT
/customproperty/{id}
Qlik Sense Enterprise Update custom property
updateCustomProperty 2 params body → 200404401
DELETE
/customproperty/{id}
Qlik Sense Enterprise Delete custom property
deleteCustomProperty 2 params → 204404401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CustomProperty (11 properties), CustomPropertyCondensed (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

CustomProperty
object
11 properties 1 required
CustomPropertyCondensed
object
4 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qlik-sense-enterprise-custom-property-api-openapi.yml Raw ↑

Other APIs Qlik Sense Enterprise publishes across the network.

Qlik Sense Engine JSON API
Qlik Sense Capabilities
Qlik Sense Enterprise About API
Qlik Sense Enterprise Access Type API
Qlik Sense Enterprise App API
Qlik Sense Enterprise App Object API
Qlik Sense Enterprise Components API
Qlik Sense Enterprise Content Library API
Qlik Sense Enterprise Data Connection API
Qlik Sense Enterprise Extension API
Qlik Sense Enterprise External URLs API
Qlik Sense Enterprise Health API