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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Atlassian

Atlassian Workflow Schemes API

The Workflow Schemes API from Atlassian — 8 operation(s) for workflow schemes.

Documentation Provider Profile APIs.io OpenAPI GitHub

Atlassian Workflow Schemes API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Workflow Schemes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 17 operations across 8 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

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

17 operations 8 paths 37 schemas 4 DELETE5 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
Contact
ecosystem@atlassian.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 17

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

Workflow Schemes 17
GET
/rest/api/3/workflowscheme
Atlassian Get All Workflow Schemes
atlassianGetallworkflowschemes 2 params → 200401403
POST
/rest/api/3/workflowscheme
Atlassian Create Workflow Scheme
atlassianCreateworkflowscheme body → 201400401403
POST
/rest/api/3/workflowscheme/read
Atlassian Bulk Get Workflow Schemes
atlassianReadworkflowschemes 1 param body → 200400401
POST
/rest/api/3/workflowscheme/update
Atlassian Update Workflow Scheme
atlassianUpdateschemes body → 200303400401
POST
/rest/api/3/workflowscheme/update/mappings
Atlassian Get Required Status Mappings For Workflow Scheme Update
atlassianUpdateworkflowschememappings body → 200400401
DELETE
/rest/api/3/workflowscheme/{id}
Atlassian Delete Workflow Scheme
atlassianDeleteworkflowscheme 1 param → 204400401403404
GET
/rest/api/3/workflowscheme/{id}
Atlassian Get Workflow Scheme
atlassianGetworkflowscheme 2 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}
Atlassian Classic Update Workflow Scheme
atlassianUpdateworkflowscheme 1 param body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/default
Atlassian Delete Default Workflow
atlassianDeletedefaultworkflow 2 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/default
Atlassian Get Default Workflow
atlassianGetdefaultworkflow 2 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/default
Atlassian Update Default Workflow
atlassianUpdatedefaultworkflow 1 param body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Atlassian Delete Workflow For Issue Type In Workflow Scheme
atlassianDeleteworkflowschemeissuetype 3 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Atlassian Get Workflow For Issue Type In Workflow Scheme
atlassianGetworkflowschemeissuetype 3 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
Atlassian Set Workflow For Issue Type In Workflow Scheme
atlassianSetworkflowschemeissuetype 2 params body → 200400401403404
DELETE
/rest/api/3/workflowscheme/{id}/workflow
Atlassian Delete Issue Types For Workflow In Workflow Scheme
atlassianDeleteworkflowmapping 3 params → 200400401403404
GET
/rest/api/3/workflowscheme/{id}/workflow
Atlassian Get Issue Types For Workflows In Workflow Scheme
atlassianGetworkflow 3 params → 200401403404
PUT
/rest/api/3/workflowscheme/{id}/workflow
Atlassian Set Issue Types For Workflow In Workflow Scheme
atlassianUpdateworkflowmapping 2 params body → 200400401403404

Schemas 37

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

StatusMetadata
object
The details of the statuses in the associated workflows.
3 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
MappingsByIssueTypeOverride
object
Overrides, for the selected issue types, any status mappings provided in statusMappingsByWorkflows. Status mappings are required when the new workflow for an i…
2 properties 2 required
DocumentVersion
object
The current version details of this workflow scheme.
2 properties 2 required
UpdatedProjectCategory
object
A project category.
4 properties
WorkflowAssociationStatusMapping
object
The list of status mappings.
2 properties 2 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
RequiredMappingByWorkflows
object
The list of required status mappings by workflow.
3 properties
WorkflowSchemeUpdateRequest
object
The update workflow scheme payload.
8 properties 4 required
StatusesPerWorkflow
object
The statuses associated with each workflow.
3 properties
PageBeanWorkflowScheme
object
A page of items.
7 properties
GroupName
object
Details about a group.
3 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required
WorkflowSchemeUpdateRequiredMappingsResponse
object
4 properties
WorkflowScheme
object
Details about a workflow scheme.
13 properties
WorkflowSchemeReadRequest
object
The workflow scheme read request body.
2 properties
SimpleListWrapperGroupName
object
5 properties
IssueTypesWorkflowMapping
object
Details about the mapping between issue types and a workflow.
4 properties
ListWrapperCallbackApplicationRole
object
WorkflowMetadataRestModel
object
Workflow metadata and usage detail.
5 properties 5 required
RequiredMappingByIssueType
object
The list of required status mappings by issue type.
2 properties
WorkflowSchemeReadResponse
object
9 properties 6 required
WorkflowSchemeAssociation
object
The explicit association between issue types and a workflow in a workflow scheme.
2 properties 2 required
ProjectDetails
object
Details about a project.
8 properties
ApplicationRole
object
Details of an application role.
14 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…
14 properties
DefaultWorkflow
object
Details about the default workflow.
2 properties 1 required
WorkflowMetadataAndIssueTypeRestModel
object
The workflow metadata and issue type IDs which use this workflow.
2 properties 2 required
AvatarUrlsBean
object
4 properties
SimpleUsage
object
Represents a usage of an entity by a project ID and related issue type IDs.
2 properties 2 required
WorkflowSchemeUpdateRequiredMappingsRequest
object
The request payload to get the required mappings for updating a workflow scheme.
3 properties 2 required
ListWrapperCallbackGroupName
object
SimpleListWrapperApplicationRole
object
5 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
IssueTypeWorkflowMapping
object
Details about the mapping between an issue type and a workflow.
3 properties
ProjectId
objectnull
Project ID details.
1 property 1 required
WorkflowScope
object
The scope of the workflow.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
AE Profile APIs.io
Atlassian Jira Software Board API
AE Profile APIs.io
Atlassian Jira Software Epic API
AE Profile APIs.io
Atlassian Jira Software Sprint API
AE Profile APIs.io
Atlassian Jira Software Development Information API
AE Profile APIs.io
Atlassian Jira Software Feature Flags API
AE Profile APIs.io
Atlassian Jira Software Deployments API
AE Profile APIs.io
Atlassian Jira Software Builds API
AE Profile APIs.io
Atlassian Jira Software Remote Links API
AE Profile APIs.io
Atlassian Jira Software Security Information API
AE Profile APIs.io
Atlassian Jira Service Management Customer API
AE Profile APIs.io
Atlassian Jira Service Management Info API
AE Profile APIs.io
#Workflow Schemes
← Back to A APIs
API Details
ID
atlassian:atlassian-workflow-schemes-api
Server
https://your-domain.atlassian.net
Docs
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/#api-group-addon
Provider
Atlassian
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=atlassian-workflow-schemes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/atlassian-workflow-schemes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Atlassian 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.