Jira

Jira Workflows API

This resource represents workflows. Use it to: * Get workflows * Create workflows * Update workflows * Delete inactive workflows * Get workflow capabilities

GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /rest/api/3/workflow/history Read a past version of a workflow · Read workflow version from history #
Ask an LLM
“What did a workflow look like at an earlier version number?”
“How far back can I retrieve a stored workflow version?”
Tell an agent
Get version {version} of workflow {workflowId} from history.
Show the statuses workflow {workflowId} had at version {version}.
POST /rest/api/3/workflow/history/list List the change history of a workflow · List workflow history entries #
Ask an LLM
“Which saved versions exist in a workflow's history?”
“Can I see when a workflow was changed over the last 60 days?”
Tell an agent
List the history entries for workflow {workflowId}.
Show every recorded revision of workflow {workflowId}.
GET /rest/api/3/workflow/search Page through published classic workflows · Get workflows paginated #
Ask an LLM
“Where can I get a paged list of published classic workflows before that endpoint is retired?”
“Can the older classic workflow listing filter by active or inactive?”
Tell an agent
Using the older classic workflow listing, get workflow {workflowName}.
Page through published classic workflows whose name contains {queryString} via the deprecated endpoint.
DELETE /rest/api/3/workflow/{entityId} Delete an inactive workflow · Delete inactive workflow #
Ask an LLM
“How do I delete a workflow nobody uses anymore?”
“Why can't I delete a workflow that is still in a workflow scheme?”
Tell an agent destructive · confirm first
Delete inactive workflow {entityId}.
Remove the unused workflow with entity ID {entityId}.
GET /rest/api/3/workflow/{workflowId}/project/{projectId}/issueTypeUsages List issue types in a project using a workflow · Get issue types in a project that are using a given workflow #
Ask an LLM
“Which issue types in a given project are governed by a particular workflow?”
“Within one project, which work types follow this workflow?”
Tell an agent
List issue types in project {projectId} that use workflow {workflowId}.
Show which work types in project {projectId} follow workflow {workflowId}.
GET /rest/api/3/workflow/{workflowId}/projectUsages List projects using a workflow · Get projects using a given workflow #
Ask an LLM
“Which projects are using a given workflow?”
“Is a workflow shared across more than one project?”
Tell an agent
List the projects that use workflow {workflowId}.
Show up to {maxResults} projects relying on workflow {workflowId}.
GET /rest/api/3/workflow/{workflowId}/workflowSchemes List workflow schemes using a workflow · Get workflow schemes which are using a given workflow #
Ask an LLM
“Which workflow schemes include a particular workflow?”
“What schemes would I need to change before a workflow can be removed?”
Tell an agent
List the workflow schemes that include workflow {workflowId}.
Find every workflow scheme referencing workflow {workflowId}.
POST /rest/api/3/workflows Bulk fetch workflows by name, ID or project · Bulk get workflows #
Ask an LLM
“Can I fetch the full definitions of several workflows at once by their IDs?”
“Which workflow applies to a given project and issue type pair, with its statuses?”
Tell an agent
Fetch the full definitions of workflows {workflowIds}.
Bulk get the workflows named {workflowNames} with their statuses.
GET /rest/api/3/workflows/capabilities Get the rules and capabilities a workflow supports · Get available workflow capabilities #
Ask an LLM
“What conditions, validators and post functions are available for a workflow?”
“Is a workflow global or scoped to a project, and which project types can it use?”
Tell an agent
Get the available capabilities for workflow {workflowId}.
Show which workflow rules I can use for issue type {issueTypeId} in project {projectId}.
POST /rest/api/3/workflows/create Create workflows and their statuses · Bulk create workflows #
Ask an LLM
“How do I create a new workflow together with its statuses?”
“Can I create project-scoped workflows if I'm only a project admin?”
Tell an agent
Create these workflows with statuses {statuses}.
Create workflows {workflows} scoped to {scope}.
POST /rest/api/3/workflows/create/validation Validate a workflow creation payload · Validate create workflows #
Ask an LLM
“Can I dry-run a new workflow definition to catch errors before creating it?”
“Which validation problems would stop my workflow create request?”
Tell an agent
Validate this create-workflows payload {payload} without creating anything.
Check new workflow payload {payload} for errors and warnings.
GET /rest/api/3/workflows/defaultEditor Get the user's default workflow editor · Get the user's default workflow editor #
Ask an LLM
“Am I set up to use the new workflow editor or the legacy one?”
“Which workflow editor opens by default for me?”
Tell an agent
Tell me which workflow editor is my default.
Check whether I'm on the new or legacy workflow editor.
POST /rest/api/3/workflows/preview Preview a workflow within a project · Preview workflow #
Ask an LLM
“Can I get a read-only preview of a project's workflow without admin rights?”
“How many workflow IDs can I include in one workflow preview?”
Tell an agent
Preview the workflow for issue types {issueTypeIds} in project {projectId}.
Show a lightweight preview of workflows {workflowIds} in project {projectId}.
GET /rest/api/3/workflows/search Search global and project workflows · Search workflows #
Ask an LLM
“Which workflows have a name containing a certain word?”
“Can I list only the active workflows used by one project?”
Tell an agent
Search workflows whose name contains {queryString}.
List workflows associated with project {projectId}.
POST /rest/api/3/workflows/update Update workflows and their statuses · Bulk update workflows #
Ask an LLM
“How do I change several existing workflows in one request?”
“Can I add statuses to workflows while updating them?”
Tell an agent
Apply these changes to existing workflows {workflows}.
Update the workflows and associate statuses {statuses} with them.
POST /rest/api/3/workflows/update/validation Validate a workflow update payload · Validate update workflows #
Ask an LLM
“Can I check my workflow edits for errors before applying them?”
“What errors would an update to existing workflows raise?”
Tell an agent
Validate this update-workflows payload {payload} before I apply it.
Dry-run workflow update payload {payload} and report problems.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-workflows-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-workflows-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-workflows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Workflows API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-workflows-api-openapi.yml