History API

Lists the current user's past tasks, and returns a single task with the input it was submitted with. From the client library, use executionsHistory() for the history.

Only tasks submitted asynchronously (/submit, including the client's ASYNC and SOCKET modes) are recorded — /execute and /stream calls don't appear here. Tasks are kept for 5 days by default; set history on the task to change how long they are kept.

Get History

Path

GET /workflows-history

Query Parameters

Parameter	Description
name	Workflow name to filter by.
version	Workflow version to filter by.
status	ACCEPTED, IN_PROGRESS, COMPLETED or FAILED. Repeat the key to filter by several: status=ACCEPTED&status=IN_PROGRESS.
groupId	Only tasks of this group.
limit	Page size. Defaults to 60.
offset	Pagination offset. Defaults to 0.

An unknown status value is rejected with a 400.

Response Body

{
  "status" : "success",
  "response" : [
    {
      "id" : "", // task id
      "status" : "COMPLETED",
      "created" : "2026-09-25T10:00:00.000Z",
      "taskName" : "example-task",
      "params" : {}, // the original task command
      "result" : {} // task result
    }
  ]
}

cURL Example

curl --location '{BASE_URL}/workflows-history?name=<TASK_NAME>&status=ACCEPTED&status=IN_PROGRESS' \
    --header 'Authorization: Bearer <USER_TOKEN>' \
    --header 'x-app-authorization: Bearer <CLIENT_TOKEN>'

Get Task Details

Returns the task together with the input it was submitted with — e.g. to restore a form after a page reload. usage has the same shape as in Get Result.

Path

GET /workflows/<TASK_NAME>/<TASK_ID>/details

Response Body

{
  "status" : "success",
  "response" : {
    "id" : "", // task id
    "status" : "ACCEPTED | IN_PROGRESS | COMPLETED | FAILED",
    "created" : "2026-09-25T10:00:00.000Z",
    "updated" : "2026-09-25T10:00:42.000Z",
    "taskName" : "example-task", // workflow the task was submitted to
    "params" : {}, // the original task command
    "result" : {}, // task result, once finished
    "progress" : { "percent" : 64, "estimatedSecondsLeft" : 110 },
    "usage" : {} // only for COMPLETED tasks
  }
}

cURL Example

curl --location '{BASE_URL}/workflows/<TASK_NAME>/{taskId}/details' \
    --header 'Authorization: Bearer <USER_TOKEN>' \
    --header 'x-app-authorization: Bearer <CLIENT_TOKEN>'

Get Grouped History

Same as above, but returns the tasks grouped by group id. A task belongs to a group when it was submitted asynchronously and its options() returned a groupId; tasks without one don't appear here.

Path

GET /workflows-history/grouped

Query Parameters

Takes name, version, status, limit and offset as above, plus:

Parameter	Description
itemsPerGroup	Maximum tasks returned per group. Defaults to 5.

Response Body

{
  "status" : "success",
  "response" : [
    {
      "groupId" : "",
      "totalCount" : 12, // tasks in the group, including those not returned
      "tasks" : [] // same entries as in Get History
    }
  ]
}