Every API here is available over the APIs.io API and to AI agents over MCP.
{
"info": {
"title": "collections",
"version": ""
},
"paths": {
"/api/v1/collections": {
"get": {
"tags": [
"collections"
],
"summary": "List collections",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionsListCollectionsResponseBody"
}
}
},
"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."
}
},
"parameters": [
{
"in": "query",
"name": "creatorId",
"schema": {
"type": "string"
},
"required": false,
"description": "The case-sensitive string used to search for a resource by creatorId."
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"required": false,
"description": "The collection's unique identifier."
},
{
"in": "query",
"name": "includeItems",
"schema": {
"type": "string"
},
"examples": {
"deep object": {
"value": "includeItems[limit]=10&includeItems[sort]=-createdAt&IncludeItems[resourceType]=app"
}
},
"required": false,
"description": "Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets."
},
{
"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\nnext or prev cursor, but not both.\n"
},
{
"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).\nThe supported properties are createdAt, updatedAt, and name. A property\nmust be prefixed by + or - to indicate ascending or descending sort order\nrespectively.\n"
},
{
"in": "query",
"name": "type",
"schema": {
"$ref": "#/components/schemas/CollectionTypes"
},
"required": false,
"description": "The case-sensitive string used to filter for a collection by type. Retrieve private collections with `private`, public collections with `publicgoverned`, and tags with `public`.\n"
},
{
"in": "query",
"name": "types",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionTypes"
}
},
"required": false,
"description": "A comma-separated case-sensitive string used to filter by multiple types."
}
],
"description": "Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.\n",
"operationId": "collections#listCollections",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"collections"
],
"summary": "Create a new collection.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/collectionResultResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Created 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."
},
"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."
}
},
"description": "Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.\n",
"operationId": "collections#createCollection",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionsCreateCollectionRequestBody"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/collections/{collectionId}": {
"get": {
"tags": [
"collections"
],
"summary": "Get a collection",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/collectionResultResponseBody"
}
}
},
"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": "collectionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The collection's unique identifier."
}
],
"description": "Finds and returns a collection.\n",
"operationId": "collections#getCollection",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"collections"
],
"summary": "Update collection",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/collectionResultResponseBody"
}
}
},
"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."
},
"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": "collectionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The collection's unique identifier."
}
],
"description": "Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).",
"operationId": "collections#PatchCollection",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionByIdPatch"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"collections"
],
"summary": "Update a collection's name and description",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/collectionResultResponseBody"
}
}
},
"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."
},
"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": "collectionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The collection's unique identifier."
}
],
"description": "Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.\n",
"operationId": "collections#updateCollection",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionsUpdateCollectionRequestBody"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"collections"
],
"summary": "Delete a collection",
"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."
},
"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": "collectionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The collection's unique identifier."
}
],
"description": "Deletes a collection and removes all items from the collection.\n",
"operationId": "collections#deleteCollection",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/collections/{collectionId}/items": {
"get": {
"tags": [
"collections"
],
"summary": "List items in a collection",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectionsListCollectionItemsResponseBody"
}
}
},
"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": "collectionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The collection's unique identifier. (This query also supports 'favorites' as the collectionID).\n"
},
{
"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": "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": "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": "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."
},
{
"in": "query",
"name": "spaceId",
"schema": {
"type": "string"
},
"required": false,
"description": "The space's unique identifier (supports \\'personal\\' as spaceId)."
},
{
"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": "Retrieves items from a collection that the user has access to.\n",
"operationId": "collections#listCollectionItems",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"collections"
],
"summary": "Add an item to a collection",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/itemResultResponseBody"
}
}
},
"headers": {
"X-B3-Traceid": {
"$ref": "#/components/headers/X-B3-Traceid"
}
},
"description": "Created 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"
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-collections.json