Qlik Spaces API
Manage shared and managed spaces for collaboration and content organization in Qlik Cloud.
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/spaces-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": "spaces",
"version": ""
},
"paths": {
"/api/v1/spaces": {
"get": {
"tags": [
"spaces"
],
"summary": "List spaces",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Spaces"
}
}
},
"description": "Spaces retrieved."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "query",
"name": "action",
"schema": {
"type": "string"
},
"required": false,
"description": "Action on space. Supports only \"?action=publish\"."
},
{
"in": "query",
"name": "environment.name",
"schema": {
"type": "string"
},
"required": false,
"description": "Environment name to filter by. For example, \"?environment.name=Development\". Use an empty value to return spaces with no environment."
},
{
"in": "query",
"name": "environmentId",
"schema": {
"type": "string"
},
"required": false,
"description": "Environment ID to filter by. For example, \"?environmentId=67f4fba37f7cbb2f04ce727a\". Use an empty value to return spaces with no environment."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
},
"required": false,
"description": "Maximum number of spaces to return."
},
{
"in": "query",
"name": "name",
"schema": {
"type": "string"
},
"required": false,
"description": "Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, \"?name=fin\" will get \"finance\", \"Final\" and \"Griffin\"."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The next page cursor. Next links make use of this."
},
{
"in": "query",
"name": "ownerId",
"schema": {
"type": "string"
},
"required": false,
"description": "Space ownerId to filter by. For example, \"?ownerId=123\"."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The previous page cursor. Previous links make use of this."
},
{
"in": "query",
"name": "roles",
"style": "form",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleType"
}
},
"explode": false,
"required": false,
"description": "Comma-separated list of roles to filter spaces by the caller's assignment role. For example, \"?roles=publisher,facilitator\" returns spaces where the caller has the publisher or facilitator role."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "string"
},
"required": false,
"description": "Field to sort by. Prefix with +/- to indicate asc/desc. For example, \"?sort=+name\" to sort ascending on Name. Supported fields are \"type\", \"name\" and \"createdAt\"."
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string"
},
"required": false,
"description": "Type(s) of space to filter. For example, \"?type=managed,shared\"."
}
],
"description": "Retrieves spaces that the current user has access to and match the query.",
"operationId": "getSpaces",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"spaces"
],
"summary": "Create a space",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Space"
}
}
},
"description": "Space created."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space create operation denied."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space already exists. `name` must be unique."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"description": "Creates a space. Spaces names must be unique. Spaces of type `data` should only be used for Qlik Talend Data Integration projects.",
"operationId": "createSpace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceCreate"
}
}
},
"required": true,
"description": "Attributes that the user wants to set for a new space."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/spaces/{spaceId}": {
"get": {
"tags": [
"spaces"
],
"summary": "Retrieve a space",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Space"
}
}
},
"description": "Space retrieved."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Too many repetetive requests."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space to retrieve."
}
],
"description": "Retrieves a single space by ID.",
"operationId": "getSpaceById",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"spaces"
],
"summary": "Update a space's properties",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Space"
}
}
},
"description": "Space patched (updated)."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space patch (update) operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space to update."
}
],
"description": "Updates one or more properties of a space. To update all properties at once, use `PUT /spaces/{spaceId}`.",
"operationId": "patchSpaceById",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpacePatch"
}
}
},
"required": true,
"description": "Attribute that the user wants to patch (update) for the specified space."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"spaces"
],
"summary": "Update a space",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Space"
}
}
},
"description": "Space updated."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space update operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space to update."
}
],
"description": "Updates a space. To update specific properties, use `PATCH /spaces/{spaceId}`.",
"operationId": "updateSpaceById",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpaceUpdate"
}
}
},
"required": true,
"description": "Attributes that the user wants to update for the specified space."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"spaces"
],
"summary": "Delete a space",
"responses": {
"204": {
"description": "Space deleted."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space delete operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"412": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space delete precondition (space not empty) failed."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space to delete."
}
],
"description": "Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.",
"operationId": "deleteSpaceById",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/spaces/{spaceId}/assignments": {
"get": {
"tags": [
"assignments"
],
"summary": "List assignments for a space",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assignments"
}
}
},
"description": "Assignments retrieved."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignments retrieve operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space of the assignment."
},
{
"in": "query",
"name": "assigneeId",
"schema": {
"type": "string"
},
"required": false,
"description": "Filters assignment for a specific assigneeid."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
},
"required": false,
"description": "Maximum number of assignments to return."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The next page cursor. Next links make use of this."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The previous page cursor. Previous links make use of this."
},
{
"in": "query",
"name": "type",
"schema": {
"$ref": "#/components/schemas/AssignmentType"
},
"required": false,
"description": "The type of assignment. Supported values are user or group."
}
],
"description": "Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all `assignableRoles` by default.",
"operationId": "getSpaceAssignments",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"assignments"
],
"summary": "Assign a user or group to a space",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assignment"
}
}
},
"description": "Assignment created."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignment create operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignment already exists. `assigneeId` must be unique."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space of the assignment."
}
],
"description": "Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all `assignableRoles` by default. Only one assignment can exist per space, per user or group.",
"operationId": "createSpaceAssignment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignmentCreate"
}
}
},
"required": true,
"description": "Attributes that the user wants to set for the assignment for the space."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/spaces/{spaceId}/assignments/{assignmentId}": {
"get": {
"tags": [
"assignments"
],
"summary": "Retrieve an assignment for a space",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assignment"
}
}
},
"description": "Assignment retrieved."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignment retrieve operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied or assignment not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "assignmentId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the assignment to retrieve."
},
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space of the assignment."
}
],
"description": "Retrieves a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID.",
"operationId": "getSpaceAssignmentById",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"assignments"
],
"summary": "Update an assignment for a space",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assignment"
}
}
},
"description": "Assignment updated."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignment update operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "assignmentId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the assignment to update."
},
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space of the assignment."
}
],
"description": "Updates a single assignment by assignment ID. Use `GET /spaces/{spaceId}/assignments` to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.",
"operationId": "updateSpaceAssignmentById",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignmentUpdate"
}
}
},
"required": true,
"description": "Attributes that the user wants to update for the specified assignment."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"assignments"
],
"summary": "Delete an assignment",
"responses": {
"204": {
"description": "Assignment deleted."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Assignment delete operation denied."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Space not found or access denied or assignment not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "assignmentId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the assignment to delete."
},
{
"in": "path",
"name": "spaceId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The ID of the space of the assignment."
}
],
"description": "Deletes an assignment.",
"operationId": "deleteSpaceAssignmentById",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/spaces/{spaceId}/shares": {
"get": {
"tags": [
"shares"
],
"summary": "List space shares",
"responses": {
"200": {
"content": {
"application/json": {
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-spaces.json