Qlik Items API
Items provides a list of core resources in the Qlik platform, including resources such as apps, automations, and data sets that a user has access to.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/items-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
{
"info": {
"title": "items",
"version": ""
},
"paths": {
"/api/v1/items": {
"get": {
"tags": [
"items"
],
"summary": "List items",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemsListItemsResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3 Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not Found response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "query",
"name": "collectionId",
"schema": {
"type": "string"
},
"required": false,
"description": "The collection's unique identifier. Used to filter for items with a specific tag (collection type `public`), or collection."
},
{
"in": "query",
"name": "createdByUserId",
"schema": {
"type": "string"
},
"required": false,
"description": "User's unique identifier."
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"required": false,
"description": "The item's unique identifier."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive)."
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-insensitive string used to search for a resource by name."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "notCreatedByUserId",
"schema": {
"type": "string"
},
"required": false,
"description": "User's unique identifier."
},
{
"in": "query",
"name": "notOwnerId",
"schema": {
"type": "string"
},
"required": false,
"description": "Owner identifier."
},
{
"in": "query",
"name": "ownerId",
"schema": {
"type": "string"
},
"required": false,
"description": "Owner identifier."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-insensitive string used to search for a resource by name or description."
},
{
"in": "query",
"name": "resourceId",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both."
},
{
"in": "query",
"name": "resourceIds",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2'"
},
{
"in": "query",
"name": "resourceLink",
"schema": {
"type": "string",
"format": "uri"
},
"required": false,
"description": "The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both."
},
{
"in": "query",
"name": "resourceSubType",
"schema": {
"type": "string"
},
"required": false,
"description": "the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter."
},
{
"in": "query",
"name": "resourceType",
"schema": {
"$ref": "#/components/schemas/itemResourceTypeEnum"
},
"required": false,
"description": "The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"+createdAt",
"-createdAt",
"+name",
"-name",
"+updatedAt",
"-updatedAt",
"+recentlyUsed",
"-recentlyUsed"
],
"type": "string"
},
"required": false,
"description": "The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, recentlyUsed and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively."
},
{
"in": "query",
"name": "spaceId",
"schema": {
"type": "string"
},
"required": false,
"description": "The space's unique identifier (supports \\'personal\\' as spaceId)."
},
{
"in": "query",
"name": "spaceType",
"schema": {
"$ref": "#/components/schemas/spaceTypeEnum"
},
"required": false,
"description": "The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'."
},
{
"in": "query",
"name": "shared",
"schema": {
"type": "boolean"
},
"description": "Whether or not to return items in a shared space.",
"x-qlik-deprecated": true
},
{
"$ref": "#/components/parameters/noActionParam"
}
],
"description": "Lists items that the user has access to.\n",
"operationId": "items#listItems",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/items/{itemId}": {
"get": {
"tags": [
"items"
],
"summary": "Get an item",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/itemResultResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3 Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not Found response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"schema": {
"type": "string"
},
"required": true,
"description": "The item's unique identifier"
}
],
"description": "Finds and returns an item.\n",
"operationId": "items#getItem",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"items"
],
"summary": "Update an item",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/itemResultResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3 Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Forbidden response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not Found response."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Conflict response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"schema": {
"type": "string"
},
"required": true,
"description": "The item's unique identifier."
}
],
"description": "Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.\n",
"operationId": "items#updateItem",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemsUpdateItemRequestBody"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"items"
],
"summary": "Delete an item",
"responses": {
"204": {
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "No Content response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Forbidden response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not Found response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"schema": {
"type": "string"
},
"required": true,
"description": "The item's unique identifier."
}
],
"description": "Deletes an item and removes the item from all collections.\n",
"operationId": "items#deleteItem",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/items/{itemId}/collections": {
"get": {
"tags": [
"items"
],
"summary": "List collections of an item",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemsListItemCollectionsResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3 Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not found response"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"schema": {
"type": "string"
},
"required": true,
"description": "The item's unique identifier."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive)."
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-sensitive string used to search for a collection by name."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-insensitive string used to search for a resource by name or description."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"+createdAt",
"-createdAt",
"+name",
"-name",
"+updatedAt",
"-updatedAt"
],
"type": "string"
},
"required": false,
"description": "The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively."
},
{
"in": "query",
"name": "type",
"schema": {
"$ref": "#/components/schemas/CollectionTypes"
},
"required": false,
"description": "The case-sensitive string used to search for a collection by type."
}
],
"description": "Finds and returns the collections (and tags) of an item. This endpoint does not return the user's favorites collection.\n",
"operationId": "items#listItemCollections",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/items/{itemId}/publisheditems": {
"get": {
"tags": [
"items"
],
"summary": "List published items",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemsListItemCollectionsResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Not Found response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"schema": {
"type": "string"
},
"required": true,
"description": "The item's unique identifier"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive)."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "resourceType",
"schema": {
"$ref": "#/components/schemas/itemResourceTypeEnum"
},
"required": false,
"description": "The case-sensitive string used to search for an item by resourceType."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"+createdAt",
"-createdAt",
"+name",
"-name",
"+updatedAt",
"-updatedAt"
],
"type": "string"
},
"required": false,
"description": "The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively."
}
],
"description": "Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.\n",
"operationId": "items#listPublishedItems",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/items/settings": {
"get": {
"tags": [
"items-settings"
],
"summary": "Get items settings",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemsSettingsResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "OK response."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Bad Request response."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Unauthorized response."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Internal Server Error response."
}
},
"description": "Finds
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-items.json