Atlassian: Get workflow transition rule configurations

Atlassian workflowTransitionRules.getWorkflowTransitionRuleConfigurations: arguments, response, policy and SDK examples.

← Workflow transition rules operations · Get started

Operation atlassian.getworkflowtransitionruleconfigurations

Provider route: GET /{cloudId}/rest/api/3/workflow/rule/config. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["workflowTransitionRules"]["getWorkflowTransitionRuleConfigurations"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.workflowTransitionRules.getWorkflowTransitionRuleConfigurations(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.workflow_transition_rules.get_workflow_transition_rule_configurations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Required within parent	Additional keys: not allowed
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 10 Format: int32 Maximum: 50
`query.types`	array	Required within parent	Unique items: true
`query.types[]`	string	Each item	Default: One of: postfunction, condition, validator
`query.keys`	array	Optional	Unique items: true
`query.keys[]`	string	Each item	Default:
`query.workflowNames`	array	Optional	Maximum length: 50 Unique items: true
`query.workflowNames[]`	string	Each item	Default: Maximum length: 50
`query.withTags`	array	Optional	Maximum length: 20 Unique items: true
`query.withTags[]`	string	Each item	Default: Maximum length: 20
`query.draft`	boolean	Optional
`query.expand`	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get workflow transition rule configurations — response body

Referenced models: Get workflow transition rule configurations — response body

Schemas

Get workflow transition rule configurations — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A page of items.
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Whether this is the last page. Read only: true
`isLast (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of items that could be returned. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the page. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of items returned. Format: int64 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	The list of items. Read only: true
`values (anyOf 1)[]`	Model	Each item	Expand Get workflow transition rule configurations — response body — values The list of items item
`values (anyOf 2)`	null	Alternative

Referenced models: Get workflow transition rule configurations — response body — values The list of items item

Get workflow transition rule configurations — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	A workflow with transition rules.
`conditions`	JSON	Optional
`conditions (anyOf 1)`	array	Alternative	The list of conditions within the workflow.
`conditions (anyOf 1)[]`	Model	Each item	Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item
`conditions (anyOf 2)`	null	Alternative
`postFunctions`	JSON	Optional
`postFunctions (anyOf 1)`	array	Alternative	The list of post functions within the workflow.
`postFunctions (anyOf 1)[]`	Model	Each item	Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item
`postFunctions (anyOf 2)`	null	Alternative
`validators`	JSON	Optional
`validators (anyOf 1)`	array	Alternative	The list of validators within the workflow.
`validators (anyOf 1)[]`	Model	Each item	Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item
`validators (anyOf 2)`	null	Alternative
`workflowId`	JSON	Optional
`workflowId (anyOf 1)`	Model	Alternative	Expand Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow
`workflowId (anyOf 2)`	null	Alternative

Referenced models: Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item, Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow

Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item

Field	Type	Presence	Description and constraints
`$`	object	Root	A workflow transition rule.
`configuration`	JSON	Optional
`configuration (anyOf 1)`	Model	Alternative	Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration
`configuration (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the transition rule.
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the rule, as defined in the Connect or the Forge app descriptor. Read only: true
`key (anyOf 2)`	null	Alternative
`transition`	JSON	Optional
`transition (anyOf 1)`	Model	Alternative	Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition Read only: true
`transition (anyOf 2)`	null	Alternative

Referenced models: Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration, Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition

Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow

Field	Type	Presence	Description and constraints
`$`	object	Root	Properties that identify a workflow.
`draft`	JSON	Optional
`draft (anyOf 1)`	boolean	Alternative	Deprecated: Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147).
`draft (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the workflow.
`name (anyOf 2)`	null	Alternative

Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration

Field	Type	Presence	Description and constraints
`$`	object	Root	A rule configuration.
`disabled`	JSON	Optional
`disabled (anyOf 1)`	boolean	Alternative	Whether the rule is disabled. Default: false
`disabled (anyOf 2)`	null	Alternative
`tag`	JSON	Optional
`tag (anyOf 1)`	string	Alternative	A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Maximum length: 255
`tag (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.
`value (anyOf 2)`	null	Alternative

Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition

Field	Type	Presence	Description and constraints
`$`	object	Root	A workflow transition.
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The transition ID. Format: int32
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The transition name.
`name (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getworkflowtransitionruleconfigurations. Catalog operation: getworkflowtransitionruleconfigurations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source

Report an issue with this page