How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Jira Workflow schemes API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflow Schemes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 19 operations across 10 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

19 operations 10 paths 40 schemas 4 DELETE6 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Workflow schemes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 19

Across 10 paths, the API surfaces 19 operations — 4 DELETE, 6 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflow Schemes 19

This resource represents workflow schemes.

GET
/rest/api/3/workflowscheme
Get all workflow schemes
getAllWorkflowSchemes 2 params → 200401403
POST
/rest/api/3/workflowscheme
Create workflow scheme
createWorkflowScheme body → 201400401403
POST
/rest/api/3/workflowscheme/project/switch
Switch workflow scheme for project
switchWorkflowSchemeForProject body → 303400401409
POST
/rest/api/3/workflowscheme/read
Bulk get workflow schemes
readWorkflowSchemes body → 200400401
POST
/rest/api/3/workflowscheme/update
Update workflow scheme
updateSchemes body → 200303400401409
POST
/rest/api/3/workflowscheme/update/mappings
Get required status mappings for workflow scheme update
getRequiredWorkflowSchemeMappings body → 200400401
DELETE
/rest/api/3/workflowscheme/{id}
Delete workflow scheme
deleteWorkflowScheme 1 param → 204400401403404
GET
/rest/api/3/workflowscheme/{id}
Get workflow scheme
getWorkflowScheme 2 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}
Classic update workflow scheme
updateWorkflowScheme 1 param body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/default
Delete default workflow
deleteDefaultWorkflow 2 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/default
Get default workflow
getDefaultWorkflow 2 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/default
Update default workflow
updateDefaultWorkflow 1 param body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Delete workflow for issue type in workflow scheme
deleteWorkflowSchemeIssueType 3 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Get workflow for issue type in workflow scheme
getWorkflowSchemeIssueType 3 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Set workflow for issue type in workflow scheme
setWorkflowSchemeIssueType 2 params body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/workflow
Delete issue types for workflow in workflow scheme
deleteWorkflowMapping 3 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/workflow
Get issue types for workflows in workflow scheme
getWorkflow 3 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/workflow
Set issue types for workflow in workflow scheme
updateWorkflowMapping 2 params body → 200400401403404
GET
/rest/api/3/workflowscheme/{workflowSchemeId}/projectUsages
Get projects which are using a given workflow scheme
getProjectUsagesForWorkflowScheme 3 params → 200400401404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are User (16 properties), ApplicationRole (14 properties), TaskProgressBeanObject (13 properties), WorkflowScheme (13 properties). Each schema is shown below with its type and property counts.

ProjectUsage
object
The project.
1 property
WorkflowSchemeReadRequest
object
The workflow scheme read request body.
2 properties
ListWrapperCallbackGroupName
object
WorkflowSchemeReadResponse
object
8 properties 5 required
RequiredMappingByIssueType
object
The list of required status mappings by issue type.
2 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
WorkflowSchemeAssociation
object
The explicit association between issue types and a workflow in a workflow scheme.
2 properties 2 required
WorkflowMetadataRestModel
object
Workflow metadata and usage detail.
4 properties 4 required
MappingsByWorkflow
object
The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has.…
3 properties 3 required
DefaultWorkflow
object
Details about the default workflow.
2 properties 1 required
PageBeanWorkflowScheme
object
A page of items.
7 properties
IssueTypeWorkflowMapping
object
Details about the mapping between an issue type and a workflow.
3 properties
WorkflowSchemeUpdateRequiredMappingsResponse
object
4 properties
WorkflowMetadataAndIssueTypeRestModel
object
The workflow metadata and issue type IDs which use this workflow.
2 properties 2 required
SimpleListWrapperGroupName
object
5 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
16 properties
WorkflowScheme
object
Details about a workflow scheme.
13 properties
DocumentVersion
object
The current version details of this workflow scheme.
2 properties
IssueTypesWorkflowMapping
object
Details about the mapping between issue types and a workflow.
4 properties
RequiredMappingByWorkflows
object
The list of required status mappings by workflow.
3 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required
WorkflowSchemeUpdateRequest
object
The update workflow scheme payload.
8 properties 4 required
WorkflowAssociationStatusMapping
object
2 properties
ListWrapperCallbackApplicationRole
object
MappingsByIssueTypeOverride
object
The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses…
2 properties
ProjectId
objectnull
Project ID details.
1 property 1 required
AvatarUrlsBean
object
4 properties
WorkflowScope
object
The scope of the workflow.
2 properties
ProjectUsagePage
object
A page of projects.
2 properties
WorkflowSchemeUpdateRequiredMappingsRequest
object
The request payload to get the required mappings for updating a workflow scheme.
3 properties 2 required
GroupName
object
Details about a group.
3 properties
ApplicationRole
object
Details of an application role.
14 properties
WorkflowSchemeProjectSwitchBean
object
Request to switch a project's workflow scheme
3 properties
StatusMetadata
object
The details of the statuses in the associated workflows.
3 properties
ProjectDetails
object
Details about a project.
8 properties
WorkflowSchemeProjectUsageDTO
object
Projects using the workflow scheme.
2 properties
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
StatusesPerWorkflow
object
The statuses associated with each workflow.
3 properties
UpdatedProjectCategory
object
A project category.
4 properties
SimpleListWrapperApplicationRole
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-workflow-schemes-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Workflow schemes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.