Spaces

Spaces are logical containers within your tenant and control access for users and groups through space roles to what content users can access.

Download OpenAPI spec

Endpoints

GET

/api/v1/spaces
POST

/api/v1/spaces
GET

/api/v1/spaces/{spaceId}
PATCH

/api/v1/spaces/{spaceId}
PUT

/api/v1/spaces/{spaceId}
DELETE

/api/v1/spaces/{spaceId}
GET

/api/v1/spaces/{spaceId}/assignments
POST

/api/v1/spaces/{spaceId}/assignments
GET

/api/v1/spaces/{spaceId}/assignments/{assignmentId}
PUT

/api/v1/spaces/{spaceId}/assignments/{assignmentId}
DELETE

/api/v1/spaces/{spaceId}/assignments/{assignmentId}
GET

/api/v1/spaces/{spaceId}/shares
POST

/api/v1/spaces/{spaceId}/shares
GET

/api/v1/spaces/{spaceId}/shares/{shareId}
PATCH

/api/v1/spaces/{spaceId}/shares/{shareId}
DELETE

/api/v1/spaces/{spaceId}/shares/{shareId}
GET

/api/v1/spaces/types

Retrieves spaces that the current user has access to and match the query.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

action string

Action on space. Supports only "?action=publish".
environment.name string

Environment name to filter by. For example, "?environment.name=Development". Use an empty value to return spaces with no environment.
environmentId string

Environment ID to filter by. For example, "?environmentId=67f4fba37f7cbb2f04ce727a". Use an empty value to return spaces with no environment.
limit integer

Maximum number of spaces to return.

default = 10, format = int32, default = 10
name string

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".
next string

The next page cursor. Next links make use of this.
ownerId string

Space ownerId to filter by. For example, "?ownerId=123".
prev string

The previous page cursor. Previous links make use of this.
roles array of strings

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.

Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
sort string

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".
type string

Type(s) of space to filter. For example, "?type=managed,shared".

Responses

200

Spaces retrieved.

application/json object
Show application/json properties
- data array of objects
  
  A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
  
  Show data properties
  
  id string
  
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
  
  meta object
  
  Information about the space settings.
  
  Show meta properties
  
  roles array of strings
  
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  assignableRoles array of strings
  
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
  
  type string
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
  
  links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  assignments object
  
  Required
  
  Show assignments properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  ownerId string
  
  The ID for the space owner.
  
  format = "uid"
  
  tenantId string
  
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
  
  createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
  
  createdBy string
  
  The ID of the user who created the space.
  
  format = "uid"
  
  updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
  
  description string
  
  The description of the space. Personal spaces do not have a description.
- meta object
  
  Show meta properties
  
  count integer
  
  Required
  
  The total number of spaces matching the current filter.
  
  personalSpace object
  
  The meta related to personal space when applicable.
  
  Show personalSpace properties
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  resourceType string
  
  Required
  
  resource type
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.

400

Bad request

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaces({})

qlik space ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "meta": {
        "roles": [
          "consumer"
        ],
        "actions": [
          "change_owner"
        ],
        "assignableRoles": [
          "consumer"
        ]
      },
      "name": "string",
      "type": "shared",
      "links": {
        "self": {
          "href": "string"
        },
        "assignments": {
          "href": "string"
        }
      },
      "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "updatedAt": "2018-10-30T07:06:22Z",
      "description": "string"
    }
  ],
  "meta": {
    "count": 42,
    "personalSpace": {
      "actions": [
        "change_owner"
      ],
      "resourceType": "string"
    }
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a space. Spaces names must be unique. Spaces of type data should only be used for Qlik Talend Data Integration projects.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

Attributes that the user wants to set for a new space.

application/json object
Show application/json properties
- name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
  
  maxLength = 256, pattern = "^[^\"\*\?\<\>\/\|\\\:]+$"
- type string
  
  Required
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
- description string
  
  The description of the space. Personal spaces do not have a description.

Responses

201

Space created.

application/json object

A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
Show application/json properties
- id string
  
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- meta object
  
  Information about the space settings.
  
  Show meta properties
  
  roles array of strings
  
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  assignableRoles array of strings
  
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
- type string
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  assignments object
  
  Required
  
  Show assignments properties
  
  href string
  
  Required
  
  URL that defines the resource.
- ownerId string
  
  The ID for the space owner.
  
  format = "uid"
- tenantId string
  
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- description string
  
  The description of the space. Personal spaces do not have a description.

400

Space Payload invalid.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Space create operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

409

Space already exists. name must be unique.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

POST /api/v1/spaces

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.createSpace({
  description:
    'Development space for users building apps for the Finance team.',
  name: 'Finance (dev)',
  type: 'shared',
})

qlik space create \
  --name 'Finance (dev)' \
  --type 'shared'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Finance (dev)","type":"shared","description":"Development space for users building apps for the Finance team."}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "name": "string",
  "type": "shared",
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  },
  "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "description": "string"
}

Retrieves a single space by ID.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space to retrieve.

format = "uid"

Responses

200

Space retrieved.

application/json object

A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
Show application/json properties
- id string
  
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- meta object
  
  Information about the space settings.
  
  Show meta properties
  
  roles array of strings
  
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  assignableRoles array of strings
  
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
- type string
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  assignments object
  
  Required
  
  Show assignments properties
  
  href string
  
  Required
  
  URL that defines the resource.
- ownerId string
  
  The ID for the space owner.
  
  format = "uid"
- tenantId string
  
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- description string
  
  The description of the space. Personal spaces do not have a description.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

429

Too many repetetive requests.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/{spaceId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpace(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik space get 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "name": "string",
  "type": "shared",
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  },
  "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "description": "string"
}

Updates one or more properties of a space. To update all properties at once, use PUT /spaces/{spaceId}.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space to update.

format = "uid"

Request Body

Required

Attribute that the user wants to patch (update) for the specified space.

application/json array of objects

A JSONPatch document as defined by RFC 6902.
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- path string
  
  Required
  
  Field of space to be patched (updated).
  
  Can be one of: "/name""/ownerId""/description"
- value string
  
  Required
  
  The value to be used within the operations.
  
  name: The name (string) of space of maxLength 256 of pattern: ^[^"*?<>/|\:]+$
  
  description: The description (string) of the space. Personal spaces do not have a description.
  
  ownerId: The user ID in uid format (string) of the space owner.

Responses

200

Space patched (updated).

application/json object

A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
Show application/json properties
- id string
  
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- meta object
  
  Information about the space settings.
  
  Show meta properties
  
  roles array of strings
  
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  assignableRoles array of strings
  
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
- type string
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  assignments object
  
  Required
  
  Show assignments properties
  
  href string
  
  Required
  
  URL that defines the resource.
- ownerId string
  
  The ID for the space owner.
  
  format = "uid"
- tenantId string
  
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- description string
  
  The description of the space. Personal spaces do not have a description.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Space patch (update) operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

PATCH /api/v1/spaces/{spaceId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.patchSpace(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'string',
    },
  ],
)

qlik space patch 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --op 'replace' \
  --path '/name' \
  --value 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"string"}]'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "name": "string",
  "type": "shared",
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  },
  "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "description": "string"
}

Updates a space. To update specific properties, use PATCH /spaces/{spaceId}.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space to update.

format = "uid"

Request Body

Required

Attributes that the user wants to update for the specified space.

application/json object
Show application/json properties
- name string
  
  The name of the space.
  
  maxLength = 256, pattern = "^[^\"\*\?\<\>\/\|\\\:]+$"
- ownerId string
  
  The user ID of the space owner.
  
  format = "uid"
- description string
  
  The description of the space. Personal spaces do not have a description.

Responses

200

Space updated.

application/json object

A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
Show application/json properties
- id string
  
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- meta object
  
  Information about the space settings.
  
  Show meta properties
  
  roles array of strings
  
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actions array of strings
  
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment""restrict"
  
  assignableRoles array of strings
  
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- name string
  
  Required
  
  The name of the space. Personal spaces do not have a name.
- type string
  
  The type of space such as shared, managed, and so on.
  
  Can be one of: "shared""managed""data"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  assignments object
  
  Required
  
  Show assignments properties
  
  href string
  
  Required
  
  URL that defines the resource.
- ownerId string
  
  The ID for the space owner.
  
  format = "uid"
- tenantId string
  
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- description string
  
  The description of the space. Personal spaces do not have a description.

400

Space Update Payload invalid.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Space update operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

PUT /api/v1/spaces/{spaceId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.updateSpace(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {
    description: 'string',
    name: 'string',
    ownerId: 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  },
)

qlik space update 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","ownerId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","description":"string"}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "name": "string",
  "type": "shared",
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  },
  "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "description": "string"
}

Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content. When non-empty-space deletion protection is enabled for the tenant, deletion is rejected if Collections contains any items in the space.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space to delete.

format = "uid"

Responses

204

Space deleted.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Space delete operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

409

Space contains content or has a delete restriction.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

412

Legacy space-delete precondition failure. The non-empty-space deletion protection returns 409.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

DELETE /api/v1/spaces/{spaceId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.deleteSpace(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik space rm 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

assigneeId string

Filters assignment for a specific assigneeid.
limit integer

Maximum number of assignments to return.

default = 10, format = int32, default = 10
next string

The next page cursor. Next links make use of this.
prev string

The previous page cursor. Previous links make use of this.
type string

The type of assignment. Supported values are user or group.

Can be one of: "user""group""bot"

Path Parameters

spaceId string

Required

The ID of the space of the assignment.

format = "uid"

Responses

200

Assignments retrieved.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Required
  
  format = "uid"
  
  type string
  
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group""bot"
  
  links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  roles array of strings
  
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  spaceId string
  
  Required
  
  The unique identifier for the space.
  
  format = "uid"
  
  tenantId string
  
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
  
  createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
  
  createdBy string
  
  The ID of the user who created the assignment.
  
  format = "uid"
  
  updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
  
  updatedBy string
  
  The ID of the user who updated the assignment.
  
  format = "uid"
  
  assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- meta object
  
  Show meta properties
  
  count integer
  
  Required
  
  The total number of assignments matching the current filter.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Assignments retrieve operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/{spaceId}/assignments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaceAssignments(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {},
)

qlik space assignment ls \
  --spaceId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "type": "user",
      "links": {
        "self": {
          "href": "string"
        },
        "space": {
          "href": "string"
        }
      },
      "roles": [
        "consumer"
      ],
      "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "updatedAt": "2018-10-30T07:06:22Z",
      "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

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.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space of the assignment.

format = "uid"

Request Body

Required

Attributes that the user wants to set for the assignment for the space.

application/json object
Show application/json properties
- type string
  
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group""bot"
- roles array of strings
  
  Required
  
  The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call GET /spaces/{spaceId} and inspect the meta.assignableRoles object.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

Responses

201

Assignment created.

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group""bot"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceId string
  
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantId string
  
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Assignment create operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

409

Assignment already exists. assigneeId must be unique.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

POST /api/v1/spaces/{spaceId}/assignments

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.createSpaceAssignment(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {
    assigneeId:
      'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
    roles: ['consumer'],
    type: 'user',
  },
)

qlik space assignment create \
  --spaceId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --assigneeId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --roles 'consumer' \
  --type 'user'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"user","roles":["consumer"],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

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.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

assignmentId string

Required

The ID of the assignment to retrieve.

format = "uid"
spaceId string

Required

The ID of the space of the assignment.

format = "uid"

Responses

200

Assignment retrieved.

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group""bot"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceId string
  
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantId string
  
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Assignment retrieve operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied or assignment not found.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/{spaceId}/assignments/{assignmentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaceAssignment(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik space assignment get 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --spaceId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

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.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

assignmentId string

Required

The ID of the assignment to update.

format = "uid"
spaceId string

Required

The ID of the space of the assignment.

format = "uid"

Request Body

Required

Attributes that the user wants to update for the specified assignment.

application/json object
Show application/json properties
- roles array of strings
  
  The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call GET /spaces/{spaceId} and inspect the meta.assignableRoles object.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"

Responses

200

Assignment updated.

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group""bot"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceId string
  
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantId string
  
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAt string
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAt string
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Assignment update operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

PUT /api/v1/spaces/{spaceId}/assignments/{assignmentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.updateSpaceAssignment(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  { roles: ['consumer'] },
)

qlik space assignment update 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --spaceId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"roles":["consumer"]}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Deletes an assignment.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

assignmentId string

Required

The ID of the assignment to delete.

format = "uid"
spaceId string

Required

The ID of the space of the assignment.

format = "uid"

Responses

204

Assignment deleted.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Assignment delete operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied or assignment not found.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

DELETE /api/v1/spaces/{spaceId}/assignments/{assignmentId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.deleteSpaceAssignment(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

qlik space assignment rm 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69' \
  --spaceId 'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Retrieves the shares of the space matching the query.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

groupId string

The ID of the group to which the resource is shared.
limit integer

Maximum number of shares to return.

default = 10, format = int32, default = 10
name string

The name of the shared resource.
next string

The next page cursor. Next links make use of this.
prev string

The previous page cursor. Previous links make use of this.
resourceId string

The ID of the shared resource.
resourceType string

The type of the shared resource.
type string

The type of share. user shares assign to a specific user, group shares assign to a specific group, and link shares provide anonymous access to a resource.

Can be one of: "user""group""link"
userId string

The ID of the user to which the resource is shared.

Path Parameters

spaceId string

Required

The ID of the space containing the shares.

format = "uid"

Responses

200

Shares retrieved.

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  Required
  
  format = "uid"
  
  type string
  
  Required
  
  Can be one of: "user""group""link"
  
  links object
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  roles array of strings
  
  The roles assigned to the assigneeId.
  
  Values may be any of: "consumer""contributor""basicconsumer"
  
  spaceId string
  
  Required
  
  format = "uid"
  
  disabled boolean
  
  If the share is disabled (effective ONLY for link shares).
  
  tenantId string
  
  Required
  
  format = "uid"
  
  createdAt string
  
  format = "date-time"
  
  createdBy string
  
  The ID of the user who created the share.
  
  format = "uid"
  
  updatedAt string
  
  format = "date-time"
  
  updatedBy string
  
  The ID of the user who updated the share.
  
  format = "uid"
  
  assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
  
  resourceId string
  
  Required
  
  The ID of the shared resource.
  
  format = "uid"
  
  resourceName string
  
  The name of the shared resource.
  
  maxLength = 256
  
  resourceType string
  
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"
- meta object
  
  Show meta properties
  
  count integer
  
  Required
  
  The total number of Shares matching the current filter.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Shares retrieve operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/{spaceId}/shares

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaceShares(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/spaces/{spaceId}/shares yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/shares" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "type": "user",
      "links": {
        "self": {
          "href": "string"
        },
        "space": {
          "href": "string"
        }
      },
      "roles": [
        "consumer"
      ],
      "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "disabled": true,
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "updatedAt": "2018-10-30T07:06:22Z",
      "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "resourceName": "string",
      "resourceType": "app"
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a share.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

spaceId string

Required

The ID of the space of the share.

format = "uid"

Request Body

Required

application/json object
Show application/json properties
- type string
  
  Required
  
  Can be one of: "user""group""link"
- roles array of strings
  
  Required
  
  The roles assigned to the assigneeId.
  
  Values may be any of: "consumer""contributor""basicconsumer"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceId string
  
  Required
  
  The resource id for the shared item.
  
  format = "uid"
- resourceType string
  
  Required
  
  The resource type for the shared item.
  
  format = "uid"

Responses

201

Share created.

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  Can be one of: "user""group""link"
- links object
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  The roles assigned to the assigneeId.
  
  Values may be any of: "consumer""contributor""basicconsumer"
- spaceId string
  
  Required
  
  format = "uid"
- disabled boolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantId string
  
  Required
  
  format = "uid"
- createdAt string
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAt string
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceId string
  
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceName string
  
  The name of the shared resource.
  
  maxLength = 256
- resourceType string
  
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Share create operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

409

Share already exists. assigneeId must be unique.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

POST /api/v1/spaces/{spaceId}/shares

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.createSpaceShare(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  {
    assigneeId:
      'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
    resourceId:
      'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
    resourceType:
      'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
    roles: ['consumer'],
    type: 'user',
  },
)

# qlik-cli has not implemented support for POST /api/v1/spaces/{spaceId}/shares yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/shares" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"user","roles":["consumer"],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceType":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Retrieves a single space share by ID.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

shareId string

Required

The ID of the share to retrieve.

format = "uid"
spaceId string

Required

The ID of the space to which the share belongs.

format = "uid"

Responses

200

Share retrieved.

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  Can be one of: "user""group""link"
- links object
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  The roles assigned to the assigneeId.
  
  Values may be any of: "consumer""contributor""basicconsumer"
- spaceId string
  
  Required
  
  format = "uid"
- disabled boolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantId string
  
  Required
  
  format = "uid"
- createdAt string
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAt string
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceId string
  
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceName string
  
  The name of the shared resource.
  
  maxLength = 256
- resourceType string
  
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Share retrieve operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied or share not found.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/{spaceId}/shares/{shareId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaceShare(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

# qlik-cli has not implemented support for GET /api/v1/spaces/{spaceId}/shares/{shareId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Updates properties of a space share (roles, and disabled state for link shares).

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

shareId string

Required

The ID of the share to update.

format = "uid"
spaceId string

Required

The ID of the space to which the share belongs.

format = "uid"

Request Body

Required

application/json array of objects

A JSONPatch document as defined by RFC 6902
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- path string
  
  Required
  
  Field of Share to be patched (updated).
  
  Can be one of: "/roles""/disabled"
- value string
  
  Required
  
  The value to be used within the operations.
  
  roles: The roles assigned to the assigneeId.
  
  disabled: To disable the share (effective ONLY for link shares).

Responses

200

Share patched (updated).

application/json object
Show application/json properties
- id string
  
  Required
  
  format = "uid"
- type string
  
  Required
  
  Can be one of: "user""group""link"
- links object
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  URL that defines the resource.
  
  space object
  
  Show space properties
  
  href string
  
  Required
  
  URL that defines the resource.
- roles array of strings
  
  The roles assigned to the assigneeId.
  
  Values may be any of: "consumer""contributor""basicconsumer"
- spaceId string
  
  Required
  
  format = "uid"
- disabled boolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantId string
  
  Required
  
  format = "uid"
- createdAt string
  
  format = "date-time"
- createdBy string
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAt string
  
  format = "date-time"
- updatedBy string
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeId string
  
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceId string
  
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceName string
  
  The name of the shared resource.
  
  maxLength = 256
- resourceType string
  
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

Share patch (update) operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Share not found or access denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

PATCH /api/v1/spaces/{spaceId}/shares/{shareId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.patchShare(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  [
    {
      op: 'replace',
      path: '/roles',
      value: 'string',
    },
  ],
)

# qlik-cli has not implemented support for PATCH /api/v1/spaces/{spaceId}/shares/{shareId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/roles","value":"string"}]'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Deletes a space share.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

shareId string

Required

The ID of the share to delete.

format = "uid"
spaceId string

Required

The ID of the space to which the share belongs.

format = "uid"

Responses

204

Share deleted.

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

403

share delete operation denied.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

404

Space not found or access denied or share not found.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

DELETE /api/v1/spaces/{spaceId}/shares/{shareId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.deleteSpaceShare(
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
  'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
)

# qlik-cli has not implemented support for DELETE /api/v1/spaces/{spaceId}/shares/{shareId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Gets a list of distinct space types available for use in the tenant.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

Space types retrieved.

application/json object

The distinct types of spaces (shared, managed, and so on).
Show application/json properties
- data array of strings
  
  The name of the type.
  
  Values may be any of: "shared""managed""data"

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- code string Deprecated Sunset 2026-12
  
  The error code.
- meta object Deprecated Sunset 2026-12
  
  Additional properties relating to the error.
- title string Deprecated Sunset 2026-12
  
  Summary of the problem.
- detail string Deprecated Sunset 2026-12
  
  A human-readable explanation specific to the occurrence of this problem.
- errors array of objects
  
  An error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The error code.
  
  meta object
  
  Additional properties relating to the error.
  
  Show meta properties
  
  source object
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
  
  title string
  
  Required
  
  Summary of the problem.
  
  detail string
  
  A human-readable explanation specific to the occurrence of this problem.
- source object Deprecated Sunset 2026-12
  
  References to the source of the error.
  
  Show source properties
  
  pointer string
  
  A JSON pointer to the property that caused the error.
  
  parameter string
  
  The URI query parameter that caused the error.
- traceId string

GET /api/v1/spaces/types

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.spaces.getSpaceTypes()

qlik space types

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/spaces/types" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    "data",
    "shared",
    "managed"
  ]
}

Spaces

Endpoints

List spaces

Facts

Query Parameters

Responses

200

400

401

500

Example Response

Create a space

Facts

Request Body

Responses

201

400

401

403

409

500

Example Response

Retrieve a space

Facts

Path Parameters

Responses

200

401

404

429

500

Example Response

Update a space's properties

Facts

Path Parameters

Request Body

Responses

200

401

403

404

500

Example Response

Update a space

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

Example Response

Delete a space

Facts

Path Parameters

Responses

204

401

403

404

409

412

500

List assignments for a space

Facts

Query Parameters

Path Parameters

Responses

200

401

403

404

500

Example Response

Assign a user or group to a space

Facts

Path Parameters