Class Workflows

Index

Constructors

Methods

createWorkflow createWorkflows deleteInactiveWorkflow getDefaultEditor getProjectUsagesForWorkflow getWorkflowProjectIssueTypeUsages getWorkflowSchemeUsagesForWorkflow getWorkflowsPaginated listWorkflowHistory readWorkflowFromHistory readWorkflowPreviews readWorkflows searchWorkflows updateWorkflows validateCreateWorkflows validateUpdateWorkflows workflowCapabilities

Constructors

constructor

new Workflows(client: Client): Version3.Workflows
Parameters
- client: Client
Returns Version3.Workflows
- Defined in src/version3/workflows.ts:9

Methods

createWorkflow

createWorkflow<T = Version3Models.WorkflowId>(
parameters: Version3Parameters.CreateWorkflow,
callback: Callback<T>,
): Promise<void>
Type Parameters
- T = Version3Models.WorkflowId
Parameters
- parameters: Version3Parameters.CreateWorkflow
- callback: Callback<T>
Returns Promise<void>
Deprecated
This will be removed on February 1, 2026; use Bulk create workflows to create both team and company-managed scoped workflows.

Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.

Permissions required: Administer Jira global permission.
- Defined in src/version3/workflows.ts:25
createWorkflow<T = Version3Models.WorkflowId>(
parameters: Version3Parameters.CreateWorkflow,
callback?: undefined,
): Promise<T>
Type Parameters
- T = Version3Models.WorkflowId
Parameters
- parameters: Version3Parameters.CreateWorkflow
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
This will be removed on February 1, 2026; use Bulk create workflows to create both team and company-managed scoped workflows.

Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.

Permissions required: Administer Jira global permission.
- Defined in src/version3/workflows.ts:43

createWorkflows

createWorkflows<T = Version3Models.WorkflowCreate>(
parameters: Version3Parameters.CreateWorkflows,
callback: Callback<T>,
): Promise<void>
Create workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCreate
Parameters
- parameters: Version3Parameters.CreateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:430
createWorkflows<T = Version3Models.WorkflowCreate>(
parameters: Version3Parameters.CreateWorkflows,
callback?: undefined,
): Promise<T>
Create workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCreate
Parameters
- parameters: Version3Parameters.CreateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:442

deleteInactiveWorkflow

deleteInactiveWorkflow<T = void>(
parameters: string | Version3Parameters.DeleteInactiveWorkflow,
callback: Callback<T>,
): Promise<void>
Deletes a workflow.

The workflow cannot be deleted if it is:
- An active workflow.
- A system workflow.
- Associated with any workflow scheme.
- Associated with any draft workflow scheme.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteInactiveWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:218

getDefaultEditor

getDefaultEditor<T = Version3Models.DefaultWorkflowEditorResponse>(
callback: Callback<T>,
): Promise<void>
Get the user's default workflow editor. This can be either the new editor or the legacy editor.
Type Parameters
- T = Version3Models.DefaultWorkflowEditorResponse
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:504
getDefaultEditor<T = Version3Models.DefaultWorkflowEditorResponse>(
callback?: undefined,
): Promise<T>
Get the user's default workflow editor. This can be either the new editor or the legacy editor.
Type Parameters
- T = Version3Models.DefaultWorkflowEditorResponse
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:506

getProjectUsagesForWorkflow

getProjectUsagesForWorkflow<T = WorkflowProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForWorkflow,
callback: Callback<T>,
): Promise<void>
Returns a page of projects using a given workflow.
Type Parameters
- T = WorkflowProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:276
getProjectUsagesForWorkflow<T = WorkflowProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForWorkflow,
callback?: undefined,
): Promise<T>
Returns a page of projects using a given workflow.
Type Parameters
- T = WorkflowProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:281

getWorkflowProjectIssueTypeUsages

getWorkflowProjectIssueTypeUsages<
    T = Version3Models.WorkflowProjectIssueTypeUsage,
>(
    parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages,
    callback: Callback<T>,
): Promise<void>
Returns a page of issue types using a given workflow within a project.
Type Parameters
- T = Version3Models.WorkflowProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:250
getWorkflowProjectIssueTypeUsages<
    T = Version3Models.WorkflowProjectIssueTypeUsage,
>(
    parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages,
    callback?: undefined,
): Promise<T>
Returns a page of issue types using a given workflow within a project.
Type Parameters
- T = Version3Models.WorkflowProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:255

getWorkflowSchemeUsagesForWorkflow

getWorkflowSchemeUsagesForWorkflow<T = Version3Models.WorkflowSchemeUsage>(
parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow,
callback: Callback<T>,
): Promise<void>
Returns a page of workflow schemes using a given workflow.
Type Parameters
- T = Version3Models.WorkflowSchemeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:302
getWorkflowSchemeUsagesForWorkflow<T = Version3Models.WorkflowSchemeUsage>(
parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow,
callback?: undefined,
): Promise<T>
Returns a page of workflow schemes using a given workflow.
Type Parameters
- T = Version3Models.WorkflowSchemeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:307

getWorkflowsPaginated

getWorkflowsPaginated<T = Version3Models.PageWorkflow>(
parameters: Version3Parameters.GetWorkflowsPaginated | undefined,
callback: Callback<T>,
): Promise<void>
Type Parameters
- T = Version3Models.PageWorkflow
Parameters
- parameters: Version3Parameters.GetWorkflowsPaginated | undefined
- callback: Callback<T>
Returns Promise<void>
Deprecated
This will be removed on June 1, 2026; use Search workflows instead.

Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.
- Defined in src/version3/workflows.ts:162
getWorkflowsPaginated<T = Version3Models.PageWorkflow>(
parameters?: Version3Parameters.GetWorkflowsPaginated,
callback?: undefined,
): Promise<T>
Type Parameters
- T = Version3Models.PageWorkflow
Parameters
- Optionalparameters: Version3Parameters.GetWorkflowsPaginated
- Optionalcallback: undefined
Returns Promise<T>
Deprecated
This will be removed on June 1, 2026; use Search workflows instead.

Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.
- Defined in src/version3/workflows.ts:180

listWorkflowHistory

listWorkflowHistory<T = Version3Models.WorkflowHistoryListResponse>(
parameters: Version3Parameters.ListWorkflowHistory,
callback: Callback<T>,
): Promise<void>
Returns a list of workflow history entries for a specified workflow id.

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
Type Parameters
- T = Version3Models.WorkflowHistoryListResponse
Parameters
- parameters: Version3Parameters.ListWorkflowHistory
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:113
listWorkflowHistory<T = Version3Models.WorkflowHistoryListResponse>(
parameters: Version3Parameters.ListWorkflowHistory,
callback?: undefined,
): Promise<T>
Returns a list of workflow history entries for a specified workflow id.

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
Type Parameters
- T = Version3Models.WorkflowHistoryListResponse
Parameters
- parameters: Version3Parameters.ListWorkflowHistory
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:126

readWorkflowFromHistory

readWorkflowFromHistory<T = Version3Models.WorkflowHistoryReadResponse>(
parameters: Version3Models.WorkflowHistoryReadRequest,
callback: Callback<T>,
): Promise<void>
Returns a workflow and related statuses for a specified workflow id and version number.

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
Type Parameters
- T = Version3Models.WorkflowHistoryReadResponse
Parameters
- parameters: Version3Models.WorkflowHistoryReadRequest
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:71
readWorkflowFromHistory<T = Version3Models.WorkflowHistoryReadResponse>(
parameters: Version3Models.WorkflowHistoryReadRequest,
callback?: undefined,
): Promise<T>
Returns a workflow and related statuses for a specified workflow id and version number.

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
Type Parameters
- T = Version3Models.WorkflowHistoryReadResponse
Parameters
- parameters: Version3Models.WorkflowHistoryReadRequest
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:84

readWorkflowPreviews

readWorkflowPreviews<T = Version3Models.WorkflowPreviewResponse>(
parameters: Version3Parameters.ReadWorkflowPreviews,
callback: Callback<T>,
): Promise<void>
Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details.

Permissions required:
- At least one of the Administer projects and View (read-only) workflow project permissions
Type Parameters
- T = Version3Models.WorkflowPreviewResponse
Parameters
- parameters: Version3Parameters.ReadWorkflowPreviews
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:524
readWorkflowPreviews<T = Version3Models.WorkflowPreviewResponse>(
parameters: Version3Parameters.ReadWorkflowPreviews,
callback?: undefined,
): Promise<T>
Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details.

Permissions required:
- At least one of the Administer projects and View (read-only) workflow project permissions
Type Parameters
- T = Version3Models.WorkflowPreviewResponse
Parameters
- parameters: Version3Parameters.ReadWorkflowPreviews
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:536

readWorkflows

readWorkflows<T = Version3Models.WorkflowRead>(
parameters: Version3Parameters.ReadWorkflows | undefined,
callback: Callback<T>,
): Promise<void>
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

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
Type Parameters
- T = Version3Models.WorkflowRead
Parameters
- parameters: Version3Parameters.ReadWorkflows | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:337
readWorkflows<T = Version3Models.WorkflowRead>(
parameters?: Version3Parameters.ReadWorkflows,
callback?: undefined,
): Promise<T>
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

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
Type Parameters
- T = Version3Models.WorkflowRead
Parameters
- Optionalparameters: Version3Parameters.ReadWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:351

searchWorkflows

searchWorkflows<T = Version3Models.WorkflowSearchResponse>(
parameters: Version3Parameters.SearchWorkflows | undefined,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned.

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
Type Parameters
- T = Version3Models.WorkflowSearchResponse
Parameters
- parameters: Version3Parameters.SearchWorkflows | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:569
searchWorkflows<T = Version3Models.WorkflowSearchResponse>(
parameters?: Version3Parameters.SearchWorkflows,
callback?: undefined,
): Promise<T>
Returns a paginated list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned.

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
Type Parameters
- T = Version3Models.WorkflowSearchResponse
Parameters
- Optionalparameters: Version3Parameters.SearchWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:584

updateWorkflows

updateWorkflows<T = Version3Models.WorkflowUpdate>(
parameters: Version3Parameters.UpdateWorkflows,
callback: Callback<T>,
): Promise<void>
Update workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowUpdate
Parameters
- parameters: Version3Parameters.UpdateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:617
updateWorkflows<T = Version3Models.WorkflowUpdate>(
parameters: Version3Parameters.UpdateWorkflows,
callback?: undefined,
): Promise<T>
Update workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowUpdate
Parameters
- parameters: Version3Parameters.UpdateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:629

validateCreateWorkflows

validateCreateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateCreateWorkflows,
callback: Callback<T>,
): Promise<void>
Validate the payload for bulk create workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateCreateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:471
validateCreateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateCreateWorkflows,
callback?: undefined,
): Promise<T>
Validate the payload for bulk create workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateCreateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:483

validateUpdateWorkflows

validateUpdateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateUpdateWorkflows,
callback: Callback<T>,
): Promise<void>
Validate the payload for bulk update workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateUpdateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:660
validateUpdateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateUpdateWorkflows,
callback?: undefined,
): Promise<T>
Validate the payload for bulk update workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateUpdateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:672

workflowCapabilities

workflowCapabilities<T = Version3Models.WorkflowCapabilities>(
parameters: Version3Models.WorkflowCapabilities | undefined,
callback: Callback<T>,
): Promise<void>
Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

Permissions required:
- Administer Jira project permission to access all, including global-scoped, workflows
- Administer projects project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCapabilities
Parameters
- parameters: Version3Models.WorkflowCapabilities | undefined
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:385
workflowCapabilities<T = Version3Models.WorkflowCapabilities>(
parameters?: Version3Models.WorkflowCapabilities,
callback?: undefined,
): Promise<T>
Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

Permissions required:
- Administer Jira project permission to access all, including global-scoped, workflows
- Administer projects project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCapabilities
Parameters
- Optionalparameters: Version3Models.WorkflowCapabilities
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:401

Class Workflows

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Workflows

Methods

createWorkflow

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

createWorkflows

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteInactiveWorkflow

Type Parameters

Parameters

Returns Promise<void>

getDefaultEditor

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectUsagesForWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowProjectIssueTypeUsages

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowSchemeUsagesForWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowsPaginated

Type Parameters

Parameters

Returns Promise<void>

Deprecated

Type Parameters

Parameters

Returns Promise<T>

Deprecated

listWorkflowHistory

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

readWorkflowFromHistory

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>