How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Groups API

Groups is the resource representing a group in the system, to which space and tenant roles can be assigned to simplify access control management.

Qlik Groups API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Administration, Business Intelligence, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 8 operations across 4 paths, organized into 2 resource areas, and defines 14 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

8 operations 4 paths 14 schemas 1 DELETE3 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/groups
Resource Areas
2

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 2 PATCH, 2 POST. They span 2 resource areas: groups, groups-settings. Each is listed below with its method, path, parameters, and response codes.

groups 6
GET
/api/v1/groups
List groups
getGroups 7 params → 200400401403429500
POST
/api/v1/groups
Create group
postGroups body → 201400401403409413429500
GET
/api/v1/groups/{groupId}
Get group by ID
getGroupById 1 param → 200403404429500
PATCH
/api/v1/groups/{groupId}
Update group by ID
updateGroupById 1 param body → 204400401403404429500
DELETE
/api/v1/groups/{groupId}
Delete group by ID
deleteGroupById 1 param → 204401404429
POST
/api/v1/groups/actions/filter
Filter groups
groups_api_actions_filter 4 params body → 200400401403429500
groups-settings 2
GET
/api/v1/groups/settings
Get group settings
groups_api_get_settings → 200401403429500
PATCH
/api/v1/groups/settings
Update group settings
patchSettings body → 204400401403429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Group (12 properties), Error (6 properties), GroupSettings (5 properties), GroupPostSchema (5 properties). Each schema is shown below with its type and property counts.

AssignedRoles
array
An array of role references. Visibility dependant on access level. Must have access to roles to view other users' assigned roles.
AssignedRolesRefIDs
array
An array of role reference identifiers.
AssignedRolesRefNames
array
An array of role reference names.
Error
object
An error object describing the error.
6 properties 2 required
Errors
object
The error response object describing the error from the handling of an HTTP request.
2 properties
Filter
object
An advanced query filter to be used for complex user querying in the tenant.
1 property
Group
object
represents a Group document
12 properties 7 required
GroupPatch
object
A JSON Patch document.
3 properties 3 required
GroupPatchSchema
array
An array of JSON Patches for a group.
GroupPostSchema
object
5 properties 1 required
Groups
object
A result object when listing groups.
3 properties
GroupSettings
object
represents a GroupSetting document
5 properties 3 required
SettingsPatch
object
A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
3 properties 3 required
SettingsPatchSchema
array
An array of JSON Patches for the groups settings.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-groups.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.