Every API here is available over the APIs.io API and to AI agents over MCP.
{
"info": {
"title": "glossaries",
"version": ""
},
"paths": {
"/api/v1/glossaries": {
"get": {
"tags": [
"glossaries"
],
"summary": "Returns all glossaries.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/glossariesResult"
}
}
},
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The user does not have privileges to perform the requested action."
}
},
"parameters": [
{
"in": "query",
"name": "countTotal",
"schema": {
"type": "boolean"
},
"description": "Optional parameter to request total count for query"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"description": "The number of glossaries to get."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the next page."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the previous page."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"name",
"+name",
"-name",
"description",
"+description",
"-description"
],
"type": "string"
},
"description": "Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending."
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"glossaries"
],
"summary": "Creates a new glossary.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/glossary"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Glossary version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully created a new glossary."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The user does not have privileges to perform the requested action."
}
},
"description": "Only a steward can create a glossary.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createGlossary"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/glossaries/{id}": {
"get": {
"tags": [
"glossaries"
],
"summary": "Retrieves a glossary.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/glossary"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Glossary version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully retrieved the glossary."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The glossary is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The id of the glossary to retrieve."
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"glossaries"
],
"summary": "Updates glossary properties with json-patch formatted data.",
"responses": {
"204": {
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Glossary version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Glossary updated successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Not authorized."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The term to patch was not found."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"headers": {
"retry-after": {
"schema": {
"type": "integer",
"default": 1
},
"description": "The amount of seconds to wait before retrying the request."
}
},
"description": "Request has been rate limited."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
},
{
"in": "header",
"name": "if-match",
"schema": {
"type": "string",
"example": "if-match: B323333"
},
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JSONPatchArray"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"glossaries"
],
"summary": "Updates a glossary.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/glossary"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Glossary version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully updated the glossary."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The record is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The id of the glossary to update."
},
{
"in": "header",
"name": "if-match",
"schema": {
"type": "string",
"example": "if-match: B323333"
},
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createGlossary"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"glossaries"
],
"summary": "Deletes a glossary and all of its terms.",
"responses": {
"204": {
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The glossary is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The id of the glossary to delete."
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/glossaries/{id}/actions/export": {
"get": {
"tags": [
"glossaries"
],
"summary": "Exports a glossary.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/exportGlossary"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "Successfully exported the glossary."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The glossary is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
},
{
"in": "query",
"name": "format",
"schema": {
"enum": [
"json",
"xlsx"
],
"type": "string"
},
"required": false,
"description": "The output format"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/glossaries/{id}/categories": {
"get": {
"tags": [
"categories"
],
"summary": "Returns a list of categories for a glossary.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/categoriesResult"
}
}
},
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The record is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
},
{
"in": "query",
"name": "countTotal",
"schema": {
"type": "boolean"
},
"description": "Optional parameter to request total count for query"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"description": "The number of terms to get."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the next page."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"description": "Optional parameter to request the previous page."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"description",
"+description",
"-description",
"name",
"+name",
"-name",
"update",
"+update",
"-update"
],
"type": "string"
},
"description": "Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending."
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"categories"
],
"summary": "Creates a new category.\n",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/category"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Category version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully created a new category."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The record is not found"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCategory"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/glossaries/{id}/categories/{categoryId}": {
"get": {
"tags": [
"categories"
],
"summary": "Retrieves a category.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/category"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Category version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully retrieved the category."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The record is not found"
}
},
"parameters": [
{
"in": "path",
"name": "categoryId",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The category id."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
},
{
"in": "header",
"name": "if-match",
"schema": {
"type": "string",
"example": "if-match: B323333"
},
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched."
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"categories"
],
"summary": "Updates category properties with json-patch formatted data.",
"responses": {
"204": {
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Category version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Category updated successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "Not authorized."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The term to patch was not found."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"headers": {
"retry-after": {
"schema": {
"type": "integer",
"default": 1
},
"description": "The amount of seconds to wait before retrying the request."
}
},
"description": "Request has been rate limited."
}
},
"parameters": [
{
"in": "path",
"name": "categoryId",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The category id."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"required": true,
"description": "The glossary id."
},
{
"in": "header",
"name": "if-match",
"schema": {
"type": "string",
"example": "if-match: B323333"
},
"description": "Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JSONPatchArray"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"categories"
],
"summary": "Updates a category.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/category"
}
}
},
"headers": {
"Etag": {
"schema": {
"type": "string"
},
"description": "Category version"
},
"Last-Modified": {
"schema": {
"type": "string"
},
"description": "Last modified date and time of the glossary"
}
},
"description": "Successfully updated the category."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The request is in incorrect format"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse"
}
}
},
"description": "The operation failed due to insufficient permissions."
},
"404": {
"content": {
"application/json": {
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-glossaries.json