Atlassian: List workflow history entries

Atlassian workflows.listWorkflowHistory: arguments, response, policy and SDK examples.

Operation atlassian.listworkflowhistory

Provider route: POST /{cloudId}/rest/api/3/workflow/history/list. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["workflows"]["listWorkflowHistory"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.workflows.listWorkflowHistory(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.workflows.list_workflow_history(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional
`body`	Model	Required within parent	Expand List workflow history entries — request body — body

Referenced models: List workflow history entries — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand List workflow history entries — response body

Referenced models: List workflow history entries — response body

Schemas

List workflow history entries — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of workflow history entries.
`entries`	JSON	Optional
`entries (anyOf 1)`	array	Alternative
`entries (anyOf 1)[]`	Model	Each item	Expand List workflow history entries — response body — entries array item
`entries (anyOf 2)`	null	Alternative

Referenced models: List workflow history entries — response body — entries array item

List workflow history entries — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	A request to read all the workflow history entries for a specific workflow. Additional keys: not allowed
`workflowId`	string	Optional	The id of the workflow to read the history for.

List workflow history entries — response body — entries array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A single entry in the WorkflowHistoryPage.
`isIntermediate`	JSON	Optional
`isIntermediate (anyOf 1)`	boolean	Alternative	Whether the version is an intermediate workflow state, sometimes created during workflow updates.
`isIntermediate (anyOf 2)`	null	Alternative
`workflowId`	JSON	Optional
`workflowId (anyOf 1)`	string	Alternative
`workflowId (anyOf 2)`	null	Alternative
`workflowVersion`	JSON	Optional
`workflowVersion (anyOf 1)`	JSON	Alternative
`workflowVersion (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`workflowVersion (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workflowVersion (anyOf 2)`	null	Alternative
`writtenAt`	JSON	Optional
`writtenAt (anyOf 1)`	string	Alternative	The timestamp when this workflow version was created.
`writtenAt (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.listworkflowhistory. Catalog operation: listworkflowhistory. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source

Report an issue with this page