Jira

Jira Workflow schemes API

This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types. A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings. Active workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme). See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.

GitHub OpenAPI

Operations 19

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

GET /rest/api/3/workflowscheme List all published workflow schemes · Get all workflow schemes #
Ask an LLM
“How do I list every workflow scheme on my Jira site?”
“Does the full workflow scheme list include draft schemes?”
Tell an agent
List all workflow schemes on the site.
Show the next {maxResults} workflow schemes starting at position {startAt}.
POST /rest/api/3/workflowscheme Create a new workflow scheme · Create workflow scheme #
Ask an LLM
“How can I set up a brand-new workflow scheme for a group of projects?”
“Can I choose a default workflow when first creating a workflow scheme?”
Tell an agent
Create a new workflow scheme named {name}.
Create workflow scheme {name} with {defaultWorkflow} as its default workflow and description {description}.
POST /rest/api/3/workflowscheme/project/switch Switch a project to a different workflow scheme · Switch workflow scheme for project #
Ask an LLM
“How do I move a classic project onto another workflow scheme?”
“What happens to issues whose statuses don't exist in the workflow scheme I'm switching a project to?”
Tell an agent
Switch project {projectId} to workflow scheme {targetSchemeId}.
Move project {projectId} onto workflow scheme {targetSchemeId}, remapping statuses per issue type with {mappingsByIssueTypeOverride}.
POST /rest/api/3/workflowscheme/read Bulk fetch workflow schemes by scheme or project · Bulk get workflow schemes #
Ask an LLM
“Which workflow schemes are my projects using?”
“Can I fetch several workflow schemes at once by their IDs?”
Tell an agent
Fetch the workflow schemes used by projects {projectIds}.
Bulk get workflow schemes {workflowSchemeIds} in one request.
POST /rest/api/3/workflowscheme/update Update a workflow scheme immediately, without drafts · Update workflow scheme #
Ask an LLM
“How can I change a team-managed project's workflow scheme with the changes applying right away?”
“Will issues be migrated when I change which statuses an issue type's workflow allows?”
Tell an agent
Rename workflow scheme {id} to {name} with description {description} at version {version}, applying immediately.
Update workflow scheme {id} (version {version}) to map workflows to issue types as {workflowsForIssueTypes}, keeping name {name} and description {description}.
POST /rest/api/3/workflowscheme/update/mappings Preview status mappings needed for a scheme change · Get required status mappings for workflow scheme update #
Ask an LLM
“Which status mappings will I need before changing the workflows in a workflow scheme?”
“Can I check per issue type what statuses must be remapped before I update a workflow scheme?”
Tell an agent
Work out the status mappings required to apply {workflowsForIssueTypes} to workflow scheme {id}.
Tell me which statuses need remapping if workflow scheme {id} gets {workflowsForIssueTypes} and default workflow {defaultWorkflowId}.
DELETE /rest/api/3/workflowscheme/{id} Delete a workflow scheme · Delete workflow scheme #
Ask an LLM
“How do I get rid of a workflow scheme I no longer use?”
“Can I delete a workflow scheme that a project is still using?”
Tell an agent destructive · confirm first
Delete workflow scheme {id}.
Remove the unused workflow scheme {id} from the site.
GET /rest/api/3/workflowscheme/{id} Get one workflow scheme's details · Get workflow scheme #
Ask an LLM
“What does a specific workflow scheme contain?”
“Can I see the pending draft of a workflow scheme instead of its active version?”
Tell an agent
Show me the details of workflow scheme {id}.
Get workflow scheme {id}, returning its draft if one exists ({returnDraftIfExists}).
PUT /rest/api/3/workflowscheme/{id} Edit a classic workflow scheme (drafts if active) · Classic update workflow scheme #
Ask an LLM
“How do I rename a company-managed project's workflow scheme?”
“What happens if I edit a workflow scheme that projects are already using?”
Tell an agent
Rename classic workflow scheme {id} to {name}.
Update classic workflow scheme {id} with description {description}, creating a draft if it is active ({updateDraftIfNeeded}).
DELETE /rest/api/3/workflowscheme/{id}/default Reset a scheme's default workflow to the system one · Delete default workflow #
Ask an LLM
“How do I revert a workflow scheme's default workflow back to Jira's built-in workflow?”
“Can I reset the default workflow on an active scheme?”
Tell an agent destructive · confirm first
Reset the default workflow of workflow scheme {id} to the system jira workflow.
Clear the custom default workflow on scheme {id}, via its draft if {updateDraftIfNeeded}.
GET /rest/api/3/workflowscheme/{id}/default Get a workflow scheme's default workflow · Get default workflow #
Ask an LLM
“Which workflow applies to unmapped issue types in a workflow scheme?”
“What is the default workflow in a scheme's draft?”
Tell an agent
Show the default workflow for workflow scheme {id}.
Get the default workflow of workflow scheme {id}, from its draft if {returnDraftIfExists}.
PUT /rest/api/3/workflowscheme/{id}/default Set a workflow scheme's default workflow · Update default workflow #
Ask an LLM
“How do I change the workflow used for all unassigned issue types in a scheme?”
“Can I change the default workflow of an active scheme through a draft?”
Tell an agent
Make {workflow} the default workflow of workflow scheme {id}.
Set the default workflow of active scheme {id} to {workflow}, updating its draft ({updateDraftIfNeeded}).
DELETE /rest/api/3/workflowscheme/{id}/issuetype/{issueType} Remove one issue type's workflow mapping in a scheme · Delete workflow for issue type in workflow scheme #
Ask an LLM
“How do I unmap an issue type so it falls back to the scheme's default workflow?”
“Can I delete a single issue type's workflow mapping from an active scheme?”
Tell an agent destructive · confirm first
Remove the workflow mapping for issue type {issueType} from workflow scheme {id}.
Unmap issue type {issueType} in scheme {id}, working on the draft if {updateDraftIfNeeded}.
GET /rest/api/3/workflowscheme/{id}/issuetype/{issueType} See which workflow an issue type uses in a scheme · Get workflow for issue type in workflow scheme #
Ask an LLM
“Which workflow does the Bug issue type follow in a given workflow scheme?”
“Can I check a single issue type's workflow mapping in a scheme's draft?”
Tell an agent
Show which workflow issue type {issueType} uses in workflow scheme {id}.
Get the draft workflow mapping for issue type {issueType} in scheme {id} ({returnDraftIfExists}).
PUT /rest/api/3/workflowscheme/{id}/issuetype/{issueType} Assign a workflow to one issue type in a scheme · Set workflow for issue type in workflow scheme #
Ask an LLM
“How do I make one issue type follow a different workflow inside a workflow scheme?”
“Can I map a single issue type to a workflow on a scheme that's already active?”
Tell an agent
Set issue type {issueType} in workflow scheme {id} to use workflow {workflow}.
Map issue type {issueType} to workflow {workflow} in active scheme {id}, updating the draft ({updateDraftIfNeeded}).
DELETE /rest/api/3/workflowscheme/{id}/workflow Remove a workflow's issue type mappings from a scheme · Delete issue types for workflow in workflow scheme #
Ask an LLM
“How do I take a workflow out of a workflow scheme entirely?”
“Can I drop all issue type mappings for one workflow on an active scheme?”
Tell an agent destructive · confirm first
Remove workflow {workflowName} and its issue type mappings from workflow scheme {id}.
Delete the {workflowName} mappings in scheme {id}, via the draft if {updateDraftIfNeeded}.
GET /rest/api/3/workflowscheme/{id}/workflow List issue types mapped to each workflow in a scheme · Get issue types for workflows in workflow scheme #
Ask an LLM
“Which issue types does each workflow cover in a workflow scheme?”
“Can I filter a scheme's workflow-to-issue-type mappings to one workflow name?”
Tell an agent
List the workflow-to-issue-type mappings in workflow scheme {id}.
Show which issue types use workflow {workflowName} in scheme {id}.
PUT /rest/api/3/workflowscheme/{id}/workflow Set the issue types a workflow covers in a scheme · Set issue types for workflow in workflow scheme #
Ask an LLM
“How do I assign several issue types to one workflow in a workflow scheme at once?”
“Can I make a workflow the scheme default while setting its issue types?”
Tell an agent
In workflow scheme {id}, assign issue types {issueTypes} to workflow {workflowName}.
Make {workflowName} the default workflow of scheme {id} as part of its issue type mapping ({defaultMapping}).
GET /rest/api/3/workflowscheme/{workflowSchemeId}/projectUsages List projects using a workflow scheme · Get projects which are using a given workflow scheme #
Ask an LLM
“Which projects are using a particular workflow scheme?”
“Is the workflow scheme I want to delete still in use by any project?”
Tell an agent
List the projects that use workflow scheme {workflowSchemeId}.
Show the next {maxResults} projects using workflow scheme {workflowSchemeId} after cursor {nextPageToken}.

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-workflow-schemes-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-workflow-schemes-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-workflow-schemes-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 Workflow schemes API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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