Qlik

App · 25 actions

Work with Qlik Cloud: reload apps and wait for them, run automations, create, copy and update apps and spaces, list items, users and data files, and start workflows when a reload finishes or an app is published.

Actions

ActionWhat it does
Cancel reloadCancel a queued or running reload.
Copy appCopy an app with its sheets, load script and data, into a space of your choice.
Create appCreate an empty analytics app in a space or your personal space.
Create automationCreate an empty Qlik Automate automation with a name and description, to build in Qlik Automate's editor.
Create spaceCreate a shared or managed space.
Delete appDelete an app for good, with its sheets and data.
Delete automationDelete an automation for good, with its run history.
Delete spaceDelete a space.
Get appGet an app's details: name, description, space, owner, when it was last reloaded and whether it is published.
Get automation runGet one run of an automation: its status, when it ran and any errors.
Get current userGet the Qlik Cloud user the API key belongs to: name, email, status and roles.
Get reloadGet a reload's status, when it ran and, if it failed, the error.
List appsList the analytics apps you can see, by space, owner or name.
List automation runsList an automation's runs, by status and start time.
List automationsList your Qlik Automate automations with their state and last run.
List data filesList the data files (CSV, Excel, QVD and others) apps load from, in your personal space or every space.
List itemsList the items in your hub (apps, automations, datasets, notes, links and more), by type, space, owner or words in their name.
List reloadsList an app's reloads, newest first, optionally only those with some statuses.
List spacesList the shared, managed and data spaces you can see.
List usersList the users in your Qlik Cloud tenant, by name or email and status.
Reload appStart reloading an app's data with its load script.
Run automationStart a run of a Qlik Automate automation.
Update appRename an app or change its description.
Update spaceRename a space or change its description.
Wait for reload to finishWait until a reload ends and return how it ended.

Cancel reload

Cancel a queued or running reload. A reload that has already ended is left as it is.

Inputs

Reload IDreload_idtextRequired
The reload's id, from 'Reload app' or 'List reloads'.

Outputs

canceledtrue/false
False if the reload had already ended
reload_idtext
The reload
statustext
Its status: CANCELING once asked, or how it had ended
Example output
{
  "canceled": true,
  "reload_id": "65f1d2e3f4a5b6c7d8e9f0a1",
  "status": "CANCELING"
}

Copy app

Copy an app with its sheets, load script and data, into a space of your choice. Returns the new app.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.
Name of the copynametext
Leave empty to let Qlik name it after the original.
Spacespace_idtext
The space to put it in. Leave empty (or choose Personal) for your personal space.
Descriptiondescriptiontext
A short description, at most 1,024 characters.

Outputs

appobject
The copy
app_idtext
The copy's id
Example output
{
  "app": {
    "createdDate": "2026-10-15T09:00:00.000Z",
    "custom": {},
    "description": "Weekly sales by region.",
    "encrypted": true,
    "hasSectionAccess": false,
    "id": "0d6a2b4c-1111-4c1e-a5d8-b43e53b3cd17",
    "isDirectQueryMode": false,
    "lastReloadTime": "2026-10-16T08:00:00.000Z",
    "modifiedDate": "2026-10-16T09:00:00.000Z",
    "name": "Sales dashboard",
    "originAppId": "",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "publishTime": "",
    "published": false,
    "spaceId": "62716f4b39b865ece543cd45",
    "thumbnail": "",
    "usage": "ANALYTICS"
  },
  "app_id": "0d6a2b4c-1111-4c1e-a5d8-b43e53b3cd17"
}

Create app

Create an empty analytics app in a space or your personal space.

Inputs

NamenametextRequired
The name, at most 256 characters.
Spacespace_idtext
The space to put it in. Leave empty (or choose Personal) for your personal space.
Descriptiondescriptiontext
A short description, at most 1,024 characters.

Outputs

appobject
The new app
app_idtext
The new app's id
Example output
{
  "app": {
    "createdDate": "2026-10-15T09:00:00.000Z",
    "custom": {},
    "description": "Weekly sales by region.",
    "encrypted": true,
    "hasSectionAccess": false,
    "id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "isDirectQueryMode": false,
    "lastReloadTime": "2026-10-16T08:00:00.000Z",
    "modifiedDate": "2026-10-16T09:00:00.000Z",
    "name": "Sales dashboard",
    "originAppId": "",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "publishTime": "",
    "published": false,
    "spaceId": "62716f4b39b865ece543cd45",
    "thumbnail": "",
    "usage": "ANALYTICS"
  },
  "app_id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16"
}

Create automation

Create an empty Qlik Automate automation with a name and description, to build in Qlik Automate's editor.

Inputs

NamenametextRequired
The automation's name.
Descriptiondescriptiontext
A short description, at most 1,024 characters.

Outputs

automationobject
The new automation
automation_idtext
The new automation's id
Example output
{
  "automation": {
    "createdAt": "2026-09-01T09:00:00Z",
    "description": "",
    "id": "a1b2c3d4-0000-4000-8000-000000000001",
    "lastRunAt": "",
    "lastRunStatus": "",
    "name": "Email the sales report",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "runMode": "manual",
    "spaceId": "",
    "state": "available",
    "updatedAt": "2026-10-01T09:00:00Z"
  },
  "automation_id": "a1b2c3d4-0000-4000-8000-000000000001"
}

Create space

Create a shared or managed space. Each space needs a name no other space in the tenant has.

Inputs

NamenametextRequired
The name, at most 256 characters.
Typespace_typetext
Shared spaces are for working together; managed spaces hold published apps. Defaults to shared.One of: shared (Shared (default)), managed.
Descriptiondescriptiontext
A short description, at most 1,024 characters.

Outputs

spaceobject
The new space
space_idtext
The new space's id
Example output
{
  "space": {
    "createdAt": "2026-09-01T09:00:00Z",
    "createdBy": "62716ab404a7bd8626af9bd6",
    "description": "Finance team apps.",
    "id": "62716f4b39b865ece543cd45",
    "meta": {
      "actions": [
        "create",
        "read",
        "update",
        "delete"
      ],
      "roles": []
    },
    "name": "Finance",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "type": "shared",
    "updatedAt": "2026-09-01T09:00:00Z"
  },
  "space_id": "62716f4b39b865ece543cd45"
}

Delete app

Delete an app for good, with its sheets and data.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.

Outputs

app_idtext
The app deleted
deletedtrue/false
Always true once deleted
Example output
{
  "app_id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
  "deleted": true
}

Delete automation

Delete an automation for good, with its run history.

Inputs

Automationautomation_idtextRequired
The automation. Pick one, or give its id from an earlier step.

Outputs

automation_idtext
The automation deleted
deletedtrue/false
Always true once deleted
Example output
{
  "automation_id": "a1b2c3d4-0000-4000-8000-000000000001",
  "deleted": true
}

Delete space

Delete a space. Qlik refuses while the space still holds apps or other content.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
space_idtext
The space deleted
Example output
{
  "deleted": true,
  "space_id": "62716f4b39b865ece543cd45"
}

Get app

Get an app's details: name, description, space, owner, when it was last reloaded and whether it is published.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.

Outputs

appobject
The app
privilegeslist
What you may do with it, such as read, update or reload
Example output
{
  "app": {
    "createdDate": "2026-10-15T09:00:00.000Z",
    "custom": {},
    "description": "Weekly sales by region.",
    "encrypted": true,
    "hasSectionAccess": false,
    "id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "isDirectQueryMode": false,
    "lastReloadTime": "2026-10-16T08:00:00.000Z",
    "modifiedDate": "2026-10-16T09:00:00.000Z",
    "name": "Sales dashboard",
    "originAppId": "",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "publishTime": "",
    "published": false,
    "spaceId": "62716f4b39b865ece543cd45",
    "thumbnail": "",
    "usage": "ANALYTICS"
  },
  "privileges": [
    "read",
    "update",
    "reload",
    "delete"
  ]
}

Get automation run

Get one run of an automation: its status, when it ran and any errors.

Inputs

Automationautomation_idtextRequired
The automation. Pick one, or give its id from an earlier step.
Run IDrun_idtextRequired
The run's id, from 'Run automation' or 'List automation runs'.

Outputs

finishedtrue/false
True once the run has ended
runobject
The run
statustext
finished, finished with warnings, failed, running and so on
succeededtrue/false
True if it finished, with or without warnings
Example output
{
  "finished": true,
  "run": {
    "context": "api_async",
    "createdAt": "2026-10-16T08:05:00Z",
    "duration": 19,
    "error": [],
    "executedById": "62716ab404a7bd8626af9bd6",
    "id": "b1b2c3d4-0000-4000-8000-000000000002",
    "isTestRun": false,
    "ownerId": "62716ab404a7bd8626af9bd6",
    "spaceId": "",
    "startTime": "2026-10-16T08:05:01Z",
    "status": "finished",
    "stopTime": "2026-10-16T08:05:20Z",
    "title": "Email the sales report"
  },
  "status": "finished",
  "succeeded": true
}

Get current user

Get the Qlik Cloud user the API key belongs to: name, email, status and roles.

Inputs

None.

Outputs

userobject
The connected user
Example output
{
  "user": {
    "assignedGroups": [],
    "assignedRoles": [
      {
        "id": "role_01",
        "name": "Developer",
        "type": "default"
      }
    ],
    "createdAt": "2026-01-10T09:00:00.000Z",
    "email": "jo@example.com",
    "id": "62716ab404a7bd8626af9bd6",
    "lastUpdatedAt": "2026-10-01T09:00:00.000Z",
    "locale": "en",
    "name": "Jo Bloggs",
    "status": "active",
    "subject": "auth0|a08D000001HxJb4IAF",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "zoneinfo": "Europe/London"
  }
}

Get reload

Get a reload's status, when it ran and, if it failed, the error.

Inputs

Reload IDreload_idtextRequired
The reload's id, from 'Reload app' or 'List reloads'.

Outputs

finishedtrue/false
True once the reload has ended, however it ended
reloadobject
The reload
reload_idtext
The reload's id, for 'Get reload' or 'Wait for reload to finish'
statustext
QUEUED, RELOADING, CANCELING, SUCCEEDED, FAILED, CANCELED or EXCEEDED_LIMIT
succeededtrue/false
True if it ended with SUCCEEDED
Example output
{
  "finished": true,
  "reload": {
    "appId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "creationTime": "2026-10-16T08:00:00Z",
    "endTime": "2026-10-16T08:01:10Z",
    "engineTime": "2026-10-16T08:01:09Z",
    "errorCode": "",
    "errorMessage": "",
    "id": "65f1d2e3f4a5b6c7d8e9f0a1",
    "log": "",
    "partial": false,
    "startTime": "2026-10-16T08:00:02Z",
    "status": "SUCCEEDED",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "type": "external",
    "userId": "62716ab404a7bd8626af9bd6"
  },
  "reload_id": "65f1d2e3f4a5b6c7d8e9f0a1",
  "status": "SUCCEEDED",
  "succeeded": true
}

List apps

List the analytics apps you can see, by space, owner or name. Each app's id is in 'app_id'. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Spacespace_idtext
Only those in this space. Choose Personal for your personal space.
Searchsearchtext
Only those whose name or description contains these words.
Ownerowner_idtext
Only those owned by this user.
Ordersorttext
How to order the list.One of: +createdAt (Oldest first (default)), -createdAt (Newest first), -updatedAt (Changed most recently), +name (Name, A to Z), -name (Name, Z to A), -recentlyUsed (Used most recently).
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

appslist
The apps
countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
Example output
{
  "apps": [
    {
      "app_id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "createdAt": "2026-10-15T09:00:00Z",
      "creatorId": "62716ab404a7bd8626af9bd6",
      "description": "Weekly sales by region.",
      "id": "65f0c1a2b3c4d5e6f7a8b9c0",
      "isFavorited": false,
      "links": {
        "open": {
          "href": "https://acme.us.qlikcloud.com/sense/app/f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16"
        }
      },
      "name": "Sales dashboard",
      "ownerId": "62716ab404a7bd8626af9bd6",
      "resourceAttributes": {
        "publishTime": "",
        "published": false
      },
      "resourceCreatedAt": "2026-10-15T09:00:00Z",
      "resourceId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "resourceLink": "/sense/app/f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "resourceReloadEndTime": "2026-10-16T08:00:00Z",
      "resourceReloadStatus": "ok",
      "resourceSubType": "",
      "resourceType": "app",
      "resourceUpdatedAt": "2026-10-16T09:00:00Z",
      "spaceId": "62716f4b39b865ece543cd45",
      "updatedAt": "2026-10-16T09:00:00Z"
    }
  ],
  "count": 1,
  "next_page": ""
}

List automation runs

List an automation's runs, by status and start time. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Automationautomation_idtextRequired
The automation. Pick one, or give its id from an earlier step.
Statusesstatuseslist
Only runs with one of these statuses.One or more of: queued, starting, running, finished, finished with warnings, failed, stopped, must stop (Stopping), not started, exceeded limit.
Started on or afterstarted_afterdate and time
Only runs that started at or after this time.
Ordersorttext
How to order the list.One of: -startTime (Started most recently), +startTime (Started longest ago), +status (By status).
Page sizelimitnumber
How many to return, 1 to 200. Defaults to 20.From 1 to 200.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
runslist
The runs
Example output
{
  "count": 1,
  "next_page": "",
  "runs": [
    {
      "context": "api_async",
      "createdAt": "2026-10-16T08:05:00Z",
      "duration": 19,
      "error": [],
      "executedById": "62716ab404a7bd8626af9bd6",
      "id": "b1b2c3d4-0000-4000-8000-000000000002",
      "isTestRun": false,
      "ownerId": "62716ab404a7bd8626af9bd6",
      "spaceId": "",
      "startTime": "2026-10-16T08:05:01Z",
      "status": "finished",
      "stopTime": "2026-10-16T08:05:20Z",
      "title": "Email the sales report"
    }
  ]
}

List automations

List your Qlik Automate automations with their state and last run. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Every automation in the tenantall_in_tenanttrue/false
Admins only: list everyone's automations, not just yours.
Ordersorttext
How to order the list.One of: +name (Name, A to Z), -name (Name, Z to A), -createdAt (Newest first), -updatedAt (Changed most recently), -lastRunAt (Run most recently).
Page sizelimitnumber
How many to return, 1 to 200. Defaults to 20.From 1 to 200.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

automationslist
The automations
countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
Example output
{
  "automations": [
    {
      "createdAt": "2026-09-01T09:00:00Z",
      "description": "",
      "id": "a1b2c3d4-0000-4000-8000-000000000001",
      "lastRunAt": "2026-10-16T08:05:00Z",
      "lastRunStatus": "finished",
      "name": "Email the sales report",
      "ownerId": "62716ab404a7bd8626af9bd6",
      "runMode": "manual",
      "spaceId": "",
      "state": "available",
      "updatedAt": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "next_page": ""
}

List data files

List the data files (CSV, Excel, QVD and others) apps load from, in your personal space or every space. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

File namename_patterntext
Only files whose name matches, with * and ? as wildcards, such as sales*.csv.
From every spaceall_spacestrue/false
Include files in every space you can see, not only your personal space.
Include foldersinclude_folderstrue/false
List folders as well as files.
Ordersorttext
How to order the list.One of: +name (Name, A to Z), -name (Name, Z to A), -modifiedDate (Changed most recently), -size (Largest first).
Page sizelimitnumber
How many to return, 1 to 1000. Defaults to 20.From 1 to 1000.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
data_fileslist
The data files
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
Example output
{
  "count": 1,
  "data_files": [
    {
      "appId": "",
      "baseName": "2026.csv",
      "createdDate": "2026-10-01T09:00:00Z",
      "folder": false,
      "folderPath": "sales",
      "id": "c1d2e3f4-0000-4000-8000-000000000003",
      "modifiedDate": "2026-10-02T09:00:00Z",
      "name": "sales/2026.csv",
      "ownerId": "62716ab404a7bd8626af9bd6",
      "size": 20480,
      "spaceId": ""
    }
  ],
  "next_page": ""
}

List items

List the items in your hub (apps, automations, datasets, notes, links and more), by type, space, owner or words in their name. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Typesresource_typeslist
Only items of these types. Leave empty for every type.One or more of: app (Analytics app), qvapp (QlikView app), qlikview (QlikView document), automation, dataset, dataasset (Data asset), dataproduct (Data product), note, genericlink (Link), script, and 5 more.
Spacespace_idtext
Only those in this space. Choose Personal for your personal space.
Searchsearchtext
Only those whose name or description contains these words.
Ownerowner_idtext
Only those owned by this user.
Ordersorttext
How to order the list.One of: +createdAt (Oldest first (default)), -createdAt (Newest first), -updatedAt (Changed most recently), +name (Name, A to Z), -name (Name, Z to A), -recentlyUsed (Used most recently).
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
itemslist
The items
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
Example output
{
  "count": 1,
  "items": [
    {
      "app_id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "createdAt": "2026-10-15T09:00:00Z",
      "creatorId": "62716ab404a7bd8626af9bd6",
      "description": "Weekly sales by region.",
      "id": "65f0c1a2b3c4d5e6f7a8b9c0",
      "isFavorited": false,
      "links": {
        "open": {
          "href": "https://acme.us.qlikcloud.com/sense/app/f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16"
        }
      },
      "name": "Sales dashboard",
      "ownerId": "62716ab404a7bd8626af9bd6",
      "resourceAttributes": {
        "publishTime": "",
        "published": false
      },
      "resourceCreatedAt": "2026-10-15T09:00:00Z",
      "resourceId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "resourceLink": "/sense/app/f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "resourceReloadEndTime": "2026-10-16T08:00:00Z",
      "resourceReloadStatus": "ok",
      "resourceSubType": "",
      "resourceType": "app",
      "resourceUpdatedAt": "2026-10-16T09:00:00Z",
      "spaceId": "62716f4b39b865ece543cd45",
      "updatedAt": "2026-10-16T09:00:00Z"
    }
  ],
  "next_page": ""
}

List reloads

List an app's reloads, newest first, optionally only those with some statuses. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.
Statusesstatuseslist
Only reloads with one of these statuses.One or more of: QUEUED, RELOADING, CANCELING, SUCCEEDED, FAILED, CANCELED, EXCEEDED_LIMIT (Exceeded limit).
Partial reloads onlypartialtrue/false
Only partial reloads when on; only full reloads when off.
Ordersorttext
How to order the list.One of: -creationTime (Newest first (default)), +creationTime (Oldest first), -endTime (Finished most recently), -startTime (Started most recently), +status (By status).
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
reloadslist
The reloads
Example output
{
  "count": 1,
  "next_page": "",
  "reloads": [
    {
      "appId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
      "creationTime": "2026-10-16T08:00:00Z",
      "endTime": "2026-10-16T08:01:10Z",
      "engineTime": "2026-10-16T08:01:09Z",
      "errorCode": "",
      "errorMessage": "",
      "id": "65f1d2e3f4a5b6c7d8e9f0a1",
      "log": "",
      "partial": false,
      "startTime": "2026-10-16T08:00:02Z",
      "status": "SUCCEEDED",
      "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
      "type": "external",
      "userId": "62716ab404a7bd8626af9bd6"
    }
  ]
}

List spaces

List the shared, managed and data spaces you can see. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Name containssearchtext
Only spaces whose name contains this.
Typespace_typetext
Only spaces of this type.One of: shared, managed, data.
Ordersorttext
How to order the list.One of: +name (Name, A to Z), -name (Name, Z to A), -createdAt (Newest first), +createdAt (Oldest first), +type (By type).
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
spaceslist
The spaces
Example output
{
  "count": 1,
  "next_page": "",
  "spaces": [
    {
      "createdAt": "2026-09-01T09:00:00Z",
      "createdBy": "62716ab404a7bd8626af9bd6",
      "description": "Finance team apps.",
      "id": "62716f4b39b865ece543cd45",
      "meta": {
        "actions": [
          "create",
          "read",
          "update",
          "delete"
        ],
        "roles": []
      },
      "name": "Finance",
      "ownerId": "62716ab404a7bd8626af9bd6",
      "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
      "type": "shared",
      "updatedAt": "2026-09-01T09:00:00Z"
    }
  ]
}

List users

List the users in your Qlik Cloud tenant, by name or email and status. Gets one page; to see more, run it again with the 'next_page' it gives.

Inputs

Searchsearchtext
Only users whose name or email contains this.
Statusesstatuseslist
Only users with one of these statuses.One or more of: active, invited, disabled, deleted, provisioned.
Ordersorttext
How to order the list.One of: +name (Name, A to Z (default)), -name (Name, Z to A), +email (Email, A to Z), -createdAt (Newest first), +createdAt (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Next pagenext_pagetext
The 'next_page' from an earlier run of this step, to get the page after it.

Outputs

countnumber
How many on this page
next_pagetext
Pass as 'Next page' to get the page after; empty on the last
userslist
The users
Example output
{
  "count": 1,
  "next_page": "",
  "users": [
    {
      "assignedGroups": [],
      "assignedRoles": [
        {
          "id": "role_01",
          "name": "Developer",
          "type": "default"
        }
      ],
      "createdAt": "2026-01-10T09:00:00.000Z",
      "email": "jo@example.com",
      "id": "62716ab404a7bd8626af9bd6",
      "lastUpdatedAt": "2026-10-01T09:00:00.000Z",
      "locale": "en",
      "name": "Jo Bloggs",
      "status": "active",
      "subject": "auth0|a08D000001HxJb4IAF",
      "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
      "zoneinfo": "Europe/London"
    }
  ]
}

Reload app

Start reloading an app's data with its load script. It returns as soon as the reload is queued; use 'Wait for reload to finish' to wait for it.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.
Partial reloadpartialtrue/false
Run a partial reload, which keeps the data already loaded.
Script variablesvariablesobject
Up to 20 variables for the load script, such as {"vRegion": "EMEA"}. Each value is at most 256 characters.

Outputs

finishedtrue/false
True once the reload has ended, however it ended
reloadobject
The reload
reload_idtext
The reload's id, for 'Get reload' or 'Wait for reload to finish'
statustext
QUEUED, RELOADING, CANCELING, SUCCEEDED, FAILED, CANCELED or EXCEEDED_LIMIT
succeededtrue/false
True if it ended with SUCCEEDED
Example output
{
  "finished": false,
  "reload": {
    "appId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "creationTime": "2026-10-16T08:00:00Z",
    "endTime": "",
    "engineTime": "",
    "errorCode": "",
    "errorMessage": "",
    "id": "65f1d2e3f4a5b6c7d8e9f0a1",
    "log": "",
    "partial": false,
    "startTime": "",
    "status": "QUEUED",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "type": "external",
    "userId": "62716ab404a7bd8626af9bd6"
  },
  "reload_id": "65f1d2e3f4a5b6c7d8e9f0a1",
  "status": "QUEUED",
  "succeeded": false
}

Run automation

Start a run of a Qlik Automate automation. It returns once the run is queued; use 'Get automation run' to see how it went.

Inputs

Automationautomation_idtextRequired
The automation. Pick one, or give its id from an earlier step.

Outputs

runobject
The run
run_idtext
The run's id
statustext
Its status, such as queued or running
Example output
{
  "run": {
    "context": "api_async",
    "createdAt": "2026-10-16T08:05:00Z",
    "duration": 0,
    "error": [],
    "executedById": "62716ab404a7bd8626af9bd6",
    "id": "b1b2c3d4-0000-4000-8000-000000000002",
    "isTestRun": false,
    "ownerId": "62716ab404a7bd8626af9bd6",
    "spaceId": "",
    "startTime": "2026-10-16T08:05:01Z",
    "status": "queued",
    "stopTime": "",
    "title": "Email the sales report"
  },
  "run_id": "b1b2c3d4-0000-4000-8000-000000000002",
  "status": "queued"
}

Update app

Rename an app or change its description. The one left empty stays as it is.

Inputs

Appapp_idtextRequired
The analytics app. Pick one, or give its id or link from an earlier step.
New namenametext
A new name. Leave empty to keep it.
New descriptiondescriptiontext
A new description. Leave empty to keep it.

Outputs

appobject
The app, as it is now
Example output
{
  "app": {
    "createdDate": "2026-10-15T09:00:00.000Z",
    "custom": {},
    "description": "Weekly sales by region.",
    "encrypted": true,
    "hasSectionAccess": false,
    "id": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "isDirectQueryMode": false,
    "lastReloadTime": "2026-10-16T08:00:00.000Z",
    "modifiedDate": "2026-10-16T09:00:00.000Z",
    "name": "Sales dashboard (2026)",
    "originAppId": "",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "publishTime": "",
    "published": false,
    "spaceId": "62716f4b39b865ece543cd45",
    "thumbnail": "",
    "usage": "ANALYTICS"
  }
}

Update space

Rename a space or change its description. Only what is given changes.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
New namenametext
A new name. Leave empty to keep it.
New descriptiondescriptiontext
A new description. Leave empty to keep it.

Outputs

spaceobject
The space, as it is now
Example output
{
  "space": {
    "createdAt": "2026-09-01T09:00:00Z",
    "createdBy": "62716ab404a7bd8626af9bd6",
    "description": "Finance team apps.",
    "id": "62716f4b39b865ece543cd45",
    "meta": {
      "actions": [
        "create",
        "read",
        "update",
        "delete"
      ],
      "roles": []
    },
    "name": "Finance (EMEA)",
    "ownerId": "62716ab404a7bd8626af9bd6",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "type": "shared",
    "updatedAt": "2026-09-01T09:00:00Z"
  }
}

Wait for reload to finish

Wait until a reload ends and return how it ended. While it runs, the workflow pauses and checks again every minute.

Inputs

Reload IDreload_idtextRequired
The reload's id, from 'Reload app' or 'List reloads'.
Wait at most (minutes)max_wait_minutesnumber
Fail if the reload is still going after this long. Defaults to 30.From 1 to 1440.

Outputs

finishedtrue/false
True once the reload has ended, however it ended
reloadobject
The reload
reload_idtext
The reload's id, for 'Get reload' or 'Wait for reload to finish'
statustext
QUEUED, RELOADING, CANCELING, SUCCEEDED, FAILED, CANCELED or EXCEEDED_LIMIT
succeededtrue/false
True if it ended with SUCCEEDED
Example output
{
  "finished": true,
  "reload": {
    "appId": "f34b91a1-ee7e-4e1c-a5d8-b43e53b3cd16",
    "creationTime": "2026-10-16T08:00:00Z",
    "endTime": "2026-10-16T08:01:10Z",
    "engineTime": "2026-10-16T08:01:09Z",
    "errorCode": "",
    "errorMessage": "",
    "id": "65f1d2e3f4a5b6c7d8e9f0a1",
    "log": "",
    "partial": false,
    "startTime": "2026-10-16T08:00:02Z",
    "status": "SUCCEEDED",
    "tenantId": "xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct",
    "type": "external",
    "userId": "62716ab404a7bd8626af9bd6"
  },
  "reload_id": "65f1d2e3f4a5b6c7d8e9f0a1",
  "status": "SUCCEEDED",
  "succeeded": true
}

On this page