Qlik Notes API
Notes provide a collaborative experience to support analytics consumption in your tenant. This API enables or disables notes.
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/notes-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": "notes",
"version": ""
},
"paths": {
"/api/v1/notes/settings": {
"get": {
"tags": [
"setting"
],
"summary": "Get the enablement status of the notes feature set for this tenant and user.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotesUserSettings"
}
}
},
"description": "Notes enablement status."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"operationId": "notesConfigGet",
"x-qlik-stability": "stable",
"x-qlik-deprecated": true,
"x-qlik-visibility": "public",
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"setting"
],
"summary": "update the settings",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteSettingsPutResponse"
}
}
},
"description": "The newly applied note settings for the tenant."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Request content error."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized user."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"operationId": "updateNoteSettingsConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteSettingsPutPayload"
}
}
},
"required": true,
"description": "A JSON payload containing note settings to put."
},
"x-qlik-stability": "stable",
"x-qlik-deprecated": true,
"x-qlik-visibility": "public",
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
}
},
"openapi": "3.0.0",
"components": {
"schemas": {
"ConfigReasonCode": {
"enum": [
"deployment",
"toggle",
"license"
],
"type": "string",
"description": "The possible states for the status of notes configuration GET or POST operation"
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"readOnly": true,
"description": "Error code specific to notes broker service."
},
"title": {
"type": "string",
"readOnly": true,
"description": "Error title."
},
"detail": {
"type": "string",
"readOnly": true,
"description": "Error cause."
}
}
},
"Errors": {
"type": "object",
"example": {
"errors": [
{
"code": "HTTP-123",
"title": "short error message",
"details": "detailed error message"
}
],
"traceId": "7326ce0d-1946-41d0-b890-609865cc42ea"
},
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"traceId": {
"type": "string",
"description": "An optional traceId"
}
}
},
"NoteSettingsPutPayload": {
"type": "object",
"properties": {
"toggledOn": {
"type": "boolean",
"description": "pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore)."
}
}
},
"NoteSettingsPutResponse": {
"type": "object",
"properties": {
"toggleOn": {
"type": "boolean",
"description": "'true' if the note feature is enabled for this tenant and user otherwise 'false'."
}
}
},
"NotesUserSettings": {
"type": "object",
"required": [
"available"
],
"properties": {
"reason": {
"$ref": "#/components/schemas/ConfigReasonCode"
},
"available": {
"type": "boolean",
"description": "'true' if the note feature is enabled for this tenant and user otherwise 'false'."
},
"lastFetch": {
"type": "string",
"description": "The timestamp for the last time this users notes settings were fetched from downstream services."
}
}
}
}
},
"servers": [
{
"url": "https://{tenant}.{region}.qlikcloud.com",
"variables": {
"region": {
"default": "us",
"description": "The region the tenant is hosted in"
},
"tenant": {
"default": "your-tenant",
"description": "Name of the tenant that will be called"
}
}
}
]
}