For scheduled capabilities such as reports, data alerts, subscriptions, and more, sharing tasks defines when these tasks execute, and tie together the resource definition with any conditions on execution.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sharing-tasks-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "sharing-tasks",
"version": ""
},
"paths": {
"/api/v1/sharing-tasks": {
"get": {
"tags": [
"sharing tasks"
],
"summary": "List sharing tasks",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingTaskRecurringListResponse"
}
}
},
"description": "The sharing task list has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "query",
"name": "appid",
"schema": {
"type": "string"
},
"required": false,
"description": "the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant."
},
{
"in": "query",
"name": "excludeDeleting",
"schema": {
"type": "boolean",
"default": false
},
"required": false,
"description": "Indicates if task with the status DELETING should be excluded from the list"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "Limit the returned result set"
},
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
},
"required": false,
"description": "Offset for finding a list of entities - used for pagination"
},
{
"in": "query",
"name": "owner",
"schema": {
"type": "string"
},
"required": false,
"description": "the filter by sharing task resource owner id."
},
{
"in": "query",
"name": "ownername",
"schema": {
"type": "string"
},
"required": false,
"description": "the filter by sharing task resource owner name."
},
{
"in": "query",
"name": "page",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the page of data."
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"enum": [
"owner",
"recipient"
],
"type": "string"
}
},
"required": false,
"description": "the filter by sharing task resource role."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"enum": [
"-datecreated",
"datecreated",
"+datecreated",
"-name",
"name",
"+name",
"-ownername",
"ownername",
"+ownername",
"-enabled",
"enabled",
"+enabled",
"-status",
"status",
"+status",
"-type",
"type",
"+type",
"-sent",
"sent",
"+sent",
"-scheduled",
"scheduled",
"+scheduled",
"-appname",
"appname",
"+appname",
"-appid",
"appid",
"+appid"
],
"type": "string"
}
},
"required": false,
"description": "Sort the returned result set by the specified field"
},
{
"in": "query",
"name": "templateId",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "array of template ids to filter by"
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"enum": [
"chart-monitoring",
"chart-sharing",
"sheet-sharing",
"template-sharing"
],
"type": "string"
}
},
"required": false,
"description": "the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of data. Only one of next or previous may be specified.",
"x-qlik-deprecated": true
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of data. Only one of next or previous may be specified.",
"x-qlik-deprecated": true
}
],
"description": "Retrieves all sharing tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.",
"operationId": "sharingTasksList",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"sharing tasks"
],
"summary": "Create sharing task",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingTaskRecurringResponse"
}
}
},
"description": "The sharing task has been successfully created."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"description": "Creates a new recurring sharing task.",
"operationId": "sharingTasksCreateRecurring",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingTaskRecurringCreateRequest"
}
}
},
"required": true,
"description": "The sharing task create request definition."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/sharing-tasks/{taskId}": {
"get": {
"tags": [
"sharing tasks"
],
"summary": "Get sharing task",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingTaskRecurringResponse"
}
}
},
"description": "Sharing task has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
},
{
"in": "query",
"name": "isViewChart",
"schema": {
"type": "boolean",
"default": false
},
"required": false,
"description": "Determines whether to update the `lastViewed` property for the sharing task, which is used to determine whether the sharing task is still in use. If set to `true`, this will be updated to current time."
}
],
"description": "Returns the details of a specific sharing task.",
"operationId": "sharingTasksIDGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"sharing tasks"
],
"summary": "Update sharing task",
"responses": {
"204": {
"description": "The sharing task has been successfully updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified task ID or body is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "A task with the specified ID was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
}
],
"description": "Updates one or more properties of a specific sharing task.",
"operationId": "sharingTasksUpdate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingTaskPatchRequestCompliantList"
}
}
},
"required": true,
"description": "The sharing task definition."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"sharing tasks"
],
"summary": "Delete sharing task",
"responses": {
"204": {
"description": "The sharing task has been successfully deleted."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified task ID is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "A task with the specified ID was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
}
],
"description": "Deletes a specific sharing task.",
"operationId": "sharingTasksDelete",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/sharing-tasks/{taskId}/actions/cancel": {
"post": {
"tags": [
"sharing tasks actions"
],
"summary": "Cancel sharing task execution",
"responses": {
"204": {
"description": "The sharing task has been successfully cancelled."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task not found, if the provided sharing task cannot be found or otherwise unable to be cancelled"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
}
],
"description": "Requests cancellation of an execution of the specified recurring sharing task.",
"operationId": "sharingTasksActionsCancel",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/sharing-tasks/{taskId}/executions": {
"get": {
"tags": [
"sharing tasks executions"
],
"summary": "List sharing task executions",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingExecutionListResponse"
}
}
},
"description": "The sharing-executions list has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 200,
"minimum": 1
},
"required": false,
"description": "Limit the returned result set"
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of data. Only one of next or previous may be specified."
},
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
},
"required": false,
"description": "Offset for pagination - how many elements to skip"
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of data. Only one of next or previous may be specified."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"enum": [
"starttime",
"-starttime",
"+starttime"
],
"type": "string"
}
},
"required": false,
"description": "Sort the returned result set by the specified field"
},
{
"in": "query",
"name": "status",
"schema": {
"enum": [
"successful",
"failed"
],
"type": "string"
},
"required": false,
"description": "Specifies a filter for a particular field and value of an execution"
}
],
"description": "Lists executions for the specified sharing task.",
"operationId": "SharingExecutionsList",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/sharing-tasks/{taskId}/executions/{executionId}": {
"get": {
"tags": [
"sharing tasks executions"
],
"summary": "Get sharing task execution",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingExecutionResponse"
}
}
},
"description": "The execution has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified task or execution ID is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "executionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The execution identifier. If value is \"latest\", the latest execution will be returned"
},
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
},
{
"in": "query",
"name": "status",
"schema": {
"enum": [
"successful",
"failed",
"cancelled"
],
"type": "string"
},
"required": false,
"description": "Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution."
}
],
"description": "Retrieves a specific sharing task execution.",
"operationId": "sharingExecutionsIDGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/sharing-tasks/{taskId}/executions/{executionId}/files/{fileAlias}": {
"get": {
"tags": [
"sharing tasks executions"
],
"summary": "Get sharing task execution file",
"responses": {
"200": {
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "The content of the file has been successfully returned."
},
"404": {
"content": {
"image/png": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "A task or execution with the specified ID was not found."
},
"500": {
"content": {
"image/png": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"image/png": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "executionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The execution identifier."
},
{
"in": "path",
"name": "fileAlias",
"schema": {
"type": "string"
},
"required": true,
"description": "The execution identifier. If value is \"latest\", the latest execution will be returned"
},
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The sharing task identifier."
},
{
"in": "query",
"name": "status",
"schema": {
"enum": [
"successful",
"failed",
"cancelled"
],
"type": "string"
},
"required": false,
"description": "Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution."
}
],
"description": "Retrieves the file content for the requested execution and file type.",
"operationId": "sharingExecutionsFilesAliasGet",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/sharing-tasks/actions/execute": {
"post": {
"tags": [
"sharing tasks actions"
],
"summary": "Start sharing task execution",
"responses": {
"204": {
"description": "The sharing task has been successfully set up for execution."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task not found, if the provided sharing task cannot be found or otherwise unable to be executed"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"description": "Requests execution of the specified recurring sharing task.",
"operationId": "sharingTasksActionsRecurring",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingActionsTriggerCreateRequest"
}
}
},
"required": true,
"description": "The sharing task execute request definition."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/sharing-tasks/settings": {
"get": {
"tags": [
"sharing settings"
],
"summary": "Get sharing settings",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharingSettings"
}
}
},
"description": "The sharing settings have been successfully returned"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"appli
# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-sharing-tasks.json