Tasks

Tasks

Operations for checking the status of long-running asynchronous tasks.

Tasks Endpoints

Get Task Status

Returns the status of a long-running task, such as publishing or exporting.

Path Parameters
  • taskKey
    string
    required

    The key of the asynchronous task to check.

Responses
GET/tasks/{taskKey}
curl https://your-portal.clickhelp.co/api/v1/tasks/ \
  --header 'Authorization: Basic username:password'

{
  "isSucceeded": true,
  "isWorking": true,
  "statusText": "…",
  "taskName": "…",
  "overallProgress": 1,
  "maxOverallProgress": 1
}

Successful operation.