Jira Align
App · 20 actions
Plan and track work in Jira Align: list, create and update epics, features and stories, read capabilities, themes, objectives, risks and dependencies, look up programs, teams, program increments and sprints, and start workflows when work items or risks are added or changed.
Actions
| Action | What it does |
|---|---|
| Create epic | Create an epic in a program, optionally under a theme. |
| Create feature | Create a feature in a program, optionally under an epic or capability and in a program increment. |
| Create story | Create a story under a feature, optionally for a team and in a program increment. |
| Delete work item | Delete a feature, epic, capability, story, theme or objective. |
| Get current user | Get the Jira Align user the connection acts as, with their teams. |
| Get dependency | Get one dependency: who asked, who must deliver and what it's about. |
| Get risk | Get one risk with its consequence, mitigation and contingency. |
| Get work item | Get one feature, epic, capability, story, theme or objective by its id. |
| List dependencies | List dependencies, newest first, optionally only those a program or team asked for, with their kind in words. |
| List portfolios | List the portfolios in Jira Align. |
| List program increments | List program increments (PIs), newest first, with their dates. |
| List programs | List programs (release trains), optionally in one portfolio. |
| List risks | List risks, newest first, optionally in one program or by words in the title. |
| List sprints | List sprints, newest first, optionally one team's or one program increment's. Gets one page; to see more, run it again with the next page it gives. |
| List teams | List agile teams, optionally in one program. |
| List users | List Jira Align users, optionally only one email address or one team's members. |
| List work items | List features, epics, capabilities, stories, themes or objectives, filtered by program, program increment, parent, title or when they changed. |
| Update epic | Change an epic's title, description, owner, theme or points. |
| Update feature | Change a feature's title, description, state, owner, parent, program increment or points. |
| Update story | Change a story's title, description, state, owner, team, feature or program increment. |
Create epic
Create an epic in a program, optionally under a theme.
Inputs
- Title
titletextRequired - Its title.
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
- Description
descriptiontext - Its description.
- Owner
owner_idtext - The person who owns it.
- Theme
theme_idtext - The theme it belongs to.
- Points
pointsnumber - Its estimate in points.At least 0.
Outputs
epicobject- The new epic
Example output
{
"epic": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"id": 10731,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"points": 40,
"primaryProgramId": 196,
"state": 1,
"themeId": 77,
"title": "Card wallet",
"type": 1
}
}Create feature
Create a feature in a program, optionally under an epic or capability and in a program increment. It starts as Pending approval unless another state is chosen.
Inputs
- Title
titletextRequired - Its title.
- Program
program_idtextRequired - The program. Pick one, or give its id from an earlier step.
- Parent epic or capability
parent_idtext - The epic or capability it belongs to.
- Program increment
program_increment_idtext - The program increment it's planned for.
- Description
descriptiontext - Its description.
- Owner
owner_idtext - The person who owns it.
- State
statetext - Its state. Defaults to Pending approval.One of:
0(Pending approval),1(Ready to start),2(In progress),3(Dev complete),4(Test complete),5(Accepted). - Points
pointsnumber - Its estimate in points.At least 0.
Outputs
featureobject- The new feature
Example output
{
"feature": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"featureSummary": "Save a card at checkout",
"id": 52001,
"isBlocked": 0,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"parentId": 10731,
"points": 8,
"primaryProgramId": 196,
"releaseId": 54,
"state": 2,
"state_name": "In progress",
"title": "Save a card at checkout",
"type": 1
}
}Create story
Create a story under a feature, optionally for a team and in a program increment. It starts as Pending approval unless another state is chosen.
Inputs
- Title
titletextRequired - Its title.
- Feature
feature_idtextRequired - The feature. Pick one, or give its id from an earlier step.
- Team
align_team_idtext - The team that will do it.
- Program increment
program_increment_idtext - The program increment it's planned for.
- Description
descriptiontext - Its description.
- Owner
owner_idtext - The person who owns it.
- State
statetext - Its state. Defaults to Pending approval.One of:
0(Pending approval),1(Ready to start),2(In progress),3(Dev complete),4(Test complete),5(Accepted).
Outputs
storyobject- The new story
Example output
{
"story": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"effortPoints": 3,
"featureId": 52001,
"id": 880412,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"programId": 196,
"releaseId": 54,
"state": 1,
"state_name": "Ready to start",
"teamId": 2063,
"title": "Store the card token"
}
}Delete work item
Delete a feature, epic, capability, story, theme or objective. Jira Align moves it to its recycle bin.
Inputs
- Kind of work item
work_item_typetextRequired - Features, epics, capabilities, stories, themes or objectives.One of:
features,epics,capabilities,stories,themes,objectives. - Work item ID
work_item_idtextRequired - The work item's id, from 'List work items' or an earlier step.
Outputs
deletedtrue/false- Always true once deleted
work_item_idnumber- The id of the work item
work_item_typetext- The kind of work item
Example output
{
"deleted": true,
"work_item_id": 52001,
"work_item_type": "features"
}Get current user
Get the Jira Align user the connection acts as, with their teams.
Inputs
None.
Outputs
userobject- The connected user
Example output
{
"user": {
"email": "jo@example.com",
"firstName": "Jo",
"fullName": "Jo Bloggs",
"id": 661838,
"isLocked": 0,
"lastName": "Bloggs",
"regionId": 17,
"roleId": 91,
"status": "Active",
"teams": [
{
"roleId": 8,
"roleName": "Architect",
"teamId": 2063,
"teamName": "Payments team",
"teamType": 1
}
],
"title": "Release train engineer",
"uid": "661838"
}
}Get dependency
Get one dependency: who asked, who must deliver and what it's about.
Inputs
- Dependency ID
dependency_idtextRequired - The dependency's id, from 'List dependencies' or an earlier step.
Outputs
dependencyobject- The dependency
Example output
{
"dependency": {
"createDate": "2026-10-15T09:00:00Z",
"dependencyType": 1,
"dependsOnProgramId": 196,
"dependsOnTeamId": 2071,
"description": "We need the vault's tokenise endpoint.",
"featureId": 52001,
"id": 1945,
"releaseId": 54,
"requestingProgramId": 196,
"requestingTeamId": 2063,
"title": "Card vault API",
"typeId": 1,
"type_name": "Team dependency",
"work_item_name": "Feature"
}
}Get risk
Get one risk with its consequence, mitigation and contingency.
Inputs
- Risk ID
risk_idtextRequired - The risk's id, from 'List risks' or an earlier step.
Outputs
riskobject- The risk
Example output
{
"risk": {
"consequence": "Saved cards ship a PI later.",
"contingency": "Ship with the old vault.",
"createDate": "2026-10-15T09:00:00Z",
"description": "The vendor's sandbox is late.",
"id": 4410,
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"mitigation": "Weekly check-in with the vendor.",
"ownerId": "661838",
"programId": 196,
"targetResolutionDate": "2026-11-30T00:00:00Z",
"title": "Card vault vendor may slip"
}
}Get work item
Get one feature, epic, capability, story, theme or objective by its id.
Inputs
- Kind of work item
work_item_typetextRequired - Features, epics, capabilities, stories, themes or objectives.One of:
features,epics,capabilities,stories,themes,objectives. - Work item ID
work_item_idtextRequired - The work item's id, from 'List work items' or an earlier step.
Outputs
itemobject- The work item
Example output
{
"item": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"featureId": 0,
"id": 52001,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"parentId": 10731,
"points": 8,
"primaryProgramId": 196,
"programId": 0,
"releaseId": 54,
"state": 2,
"teamId": 0,
"title": "Save a card at checkout"
}
}List dependencies
List dependencies, newest first, optionally only those a program or team asked for, with their kind in words. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Program
program_idtext - Only dependencies this program asked for.
- Team
align_team_idtext - Only dependencies this team asked for.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
dependencieslist- Dependencies
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
Example output
{
"count": 1,
"dependencies": [
{
"createDate": "2026-10-15T09:00:00Z",
"dependencyType": 1,
"dependsOnProgramId": 196,
"dependsOnTeamId": 2071,
"description": "We need the vault's tokenise endpoint.",
"featureId": 52001,
"id": 1945,
"releaseId": 54,
"requestingProgramId": 196,
"requestingTeamId": 2063,
"title": "Card vault API",
"typeId": 1,
"type_name": "Team dependency",
"work_item_name": "Feature"
}
],
"next_skip": 0
}List portfolios
List the portfolios in Jira Align. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
portfolioslist- Portfolios
Example output
{
"count": 1,
"next_skip": 0,
"portfolios": [
{
"description": "Customer-facing products",
"id": 12,
"title": "Digital"
}
]
}List program increments
List program increments (PIs), newest first, with their dates. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
program_incrementslist- Program increments
Example output
{
"count": 1,
"next_skip": 0,
"program_increments": [
{
"description": "October to December",
"endDate": "2026-12-18T00:00:00Z",
"id": 54,
"portfolioId": 12,
"programIds": [
196
],
"releaseNumber": "2026.4",
"shortName": "PI-26.4",
"startDate": "2026-10-05T00:00:00Z",
"status": "Active",
"title": "PI 2026.4"
}
]
}List programs
List programs (release trains), optionally in one portfolio. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Portfolio
portfolio_idtext - Only programs in this portfolio.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
programslist- Programs
Example output
{
"count": 1,
"next_skip": 0,
"programs": [
{
"description": "The payments release train",
"id": 196,
"lastUpdatedDate": "2026-10-01T09:00:00Z",
"portfolioId": 12,
"regionId": 17,
"title": "Payments"
}
]
}List risks
List risks, newest first, optionally in one program or by words in the title. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Program
program_idtext - Only risks in this program.
- Title contains
title_containstext - Only risks whose title contains these words.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
riskslist- Risks
Example output
{
"count": 1,
"next_skip": 0,
"risks": [
{
"consequence": "Saved cards ship a PI later.",
"contingency": "Ship with the old vault.",
"createDate": "2026-10-15T09:00:00Z",
"description": "The vendor's sandbox is late.",
"id": 4410,
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"mitigation": "Weekly check-in with the vendor.",
"ownerId": "661838",
"programId": 196,
"targetResolutionDate": "2026-11-30T00:00:00Z",
"title": "Card vault vendor may slip"
}
]
}List sprints
List sprints, newest first, optionally one team's or one program increment's. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Team
align_team_idtext - Only this team's sprints.
- Program increment
program_increment_idtext - Only sprints in this program increment.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
sprintslist- Sprints
Example output
{
"count": 1,
"next_skip": 0,
"sprints": [
{
"beginDate": "2026-10-05T00:00:00Z",
"endDate": "2026-10-16T00:00:00Z",
"goal": "Card wallet ready for testing",
"id": 9012,
"programId": 196,
"releaseId": 54,
"shortName": "S1",
"state": 1,
"teamId": 2063,
"title": "PAY Sprint 26.4.1"
}
]
}List teams
List agile teams, optionally in one program. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Program
program_idtext - Only teams in this program.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
teamslist- Teams
Example output
{
"count": 1,
"next_skip": 0,
"teams": [
{
"description": "Builds checkout",
"id": 2063,
"isActive": 1,
"name": "Payments team",
"ownerId": "661802",
"programId": 196,
"regionId": 16,
"shortName": "PAY",
"sprintPrefix": "PAY",
"type": 1
}
]
}List users
List Jira Align users, optionally only one email address or one team's members. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Only the user with this email address.
- Team
align_team_idtext - Only members of this team.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
userslist- Users
Example output
{
"count": 1,
"next_skip": 0,
"users": [
{
"email": "jo@example.com",
"firstName": "Jo",
"fullName": "Jo Bloggs",
"id": 661838,
"isLocked": 0,
"lastName": "Bloggs",
"regionId": 17,
"roleId": 91,
"status": "Active",
"teams": [
{
"roleId": 8,
"roleName": "Architect",
"teamId": 2063,
"teamName": "Payments team",
"teamType": 1
}
],
"title": "Release train engineer",
"uid": "661838"
}
]
}List work items
List features, epics, capabilities, stories, themes or objectives, filtered by program, program increment, parent, title or when they changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Kind of work item
work_item_typetextRequired - Features, epics, capabilities, stories, themes or objectives.One of:
features,epics,capabilities,stories,themes,objectives. - Program
program_idtext - Only work items in this program. Themes can't be filtered by program.
- Program increment
program_increment_idtext - Only features or stories in this program increment.
- Parent ID
parent_idtext - Only work items under this parent: a feature's or capability's epic (or a feature's capability), or a story's feature.
- Title contains
title_containstext - Only work items whose title contains these words.
- Changed since
changed_sincedate and time - Only work items changed on or after this day. Jira Align compares the date only, not the time.
- Order
ordertext - Which come first. Defaults to newest first.One of:
newest(Newest first),changed(Recently changed first),oldest(Oldest first). - Include recycled
include_recycledtrue/false - Also list work items in the recycle bin. Off by default.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Skip
skipnumber - How many to skip, to get a later page: the 'next_skip' a list gave.At least 0.
Outputs
countnumber- How many on this page
itemslist- The work items
next_skipnumber- Pass as 'Skip' to get the next page; 0 when this is the last page
Example output
{
"count": 1,
"items": [
{
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"featureId": 0,
"id": 52001,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"parentId": 10731,
"points": 8,
"primaryProgramId": 196,
"programId": 0,
"releaseId": 54,
"state": 2,
"teamId": 0,
"title": "Save a card at checkout"
}
],
"next_skip": 0
}Update epic
Change an epic's title, description, owner, theme or points. Only the fields given change.
Inputs
- Epic
epic_idtextRequired - The epic. Pick one, or give its id from an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- Owner
owner_idtext - The person who owns it.
- Theme
theme_idtext - A new theme.
- Points
pointsnumber - Its estimate in points.At least 0.
Outputs
epicobject- The epic as it is now
Example output
{
"epic": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"id": 10731,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"points": 40,
"primaryProgramId": 196,
"state": 1,
"themeId": 77,
"title": "Card wallet",
"type": 1
}
}Update feature
Change a feature's title, description, state, owner, parent, program increment or points. Only the fields given change.
Inputs
- Feature
feature_idtextRequired - The feature. Pick one, or give its id from an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- State
statetext - A new state.One of:
0(Pending approval),1(Ready to start),2(In progress),3(Dev complete),4(Test complete),5(Accepted). - Owner
owner_idtext - The person who owns it.
- Parent epic or capability
parent_idtext - The epic or capability it belongs to.
- Program increment
program_increment_idtext - A new program increment.
- Points
pointsnumber - Its estimate in points.At least 0.
Outputs
featureobject- The feature as it is now
Example output
{
"feature": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"featureSummary": "Save a card at checkout",
"id": 52001,
"isBlocked": 0,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"parentId": 10731,
"points": 8,
"primaryProgramId": 196,
"releaseId": 54,
"state": 2,
"state_name": "In progress",
"title": "Save a card at checkout",
"type": 1
}
}Update story
Change a story's title, description, state, owner, team, feature or program increment. Only the fields given change.
Inputs
- Story ID
story_idtextRequired - The story's id, from 'List work items' or an earlier step.
- Title
titletext - A new title. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- State
statetext - A new state.One of:
0(Pending approval),1(Ready to start),2(In progress),3(Dev complete),4(Test complete),5(Accepted). - Owner
owner_idtext - The person who owns it.
- Team
align_team_idtext - A new team.
- Feature
feature_idtext - Move it to this feature.
- Program increment
program_increment_idtext - A new program increment.
Outputs
storyobject- The story as it is now
Example output
{
"story": {
"createDate": "2026-10-15T09:00:00Z",
"createdBy": "Jo Bloggs",
"description": "Let shoppers save a card for next time.",
"effortPoints": 3,
"featureId": 52001,
"id": 880412,
"isRecycled": false,
"lastUpdatedBy": "Jo Bloggs",
"lastUpdatedDate": "2026-10-16T14:30:00Z",
"ownerId": "661838",
"programId": 196,
"releaseId": 54,
"state": 1,
"state_name": "Ready to start",
"teamId": 2063,
"title": "Store the card token"
}
}