Skip to content

Function: listWorkflowHistory() ​

ts
function listWorkflowHistory(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  entries?: object[];
}>;

Defined in: src/cloud/api/workflows.ts:89

Returns a list of workflow history entries for a specified workflow id.

Note: Stored workflow data expires after 60 days. Additionally, no data from before the 30th of October 2025 is available.

Permissions required:

  • Administer Jira global permission to access all, including project-scoped, workflows
  • At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ expand?: | string & object | "includeIntermediateWorkflows" | (string & object | "includeIntermediateWorkflows")[]; workflowId?: string; }-
parameters.expand?| string & object | "includeIntermediateWorkflows" | (string & object | "includeIntermediateWorkflows")[]Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: - includeIntermediateWorkflows Includes intermediate workflow versions that are sometimes created during workflow updates or migrations. By default, these are omitted from the response.
parameters.workflowId?stringThe id of the workflow to read the history for.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; entries?: object[]; }>