provider Workflow transition properties GET
/rest/api/3/workflow/transitions/{transitionId}/properties @utdk/jira
/rest/api/3/workflow/transitions/{transitionId}/properties Get workflow transition properties
This will be removed on [June 1, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-2570); fetch transition properties from [Bulk get workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-post) instead.
Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
- transitionId path required
- The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
- integer
- includeReservedKeys query
- Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.
- boolean
- key query
- The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
- string
- workflowName query required
- The name of the workflow that the transition belongs to.
- string
- workflowMode query
- The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.
- enum: live, draft
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.getworkflowtransitionproperties({
"includeReservedKeys": false,
"workflowMode": "live"
})