Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

Jira and Jira Align Integration: Jira Rest API Calls for Configuration and Troubleshooting

The Jira and Jira Align Integration works by Jira Align sending outbound rest API calls from Jira Align to Jira to sync issues, boards, sprints, and fix versions between the applications.  A couple of Jira rest API calls can be utilized to help configure the connector and to troubleshoot common sync errors.



This call is the health check the Jira and Jira Align integration utilizes to validate API connectivity between Jira and Jira Align.  This API calls does not require authentication to receive a response from Jira and for this reason Jira Align does not send an authentication header with this API call.  Under Jira Align Admin > Jira Settings > Jira Connectors there is a “Test Now” button that utilizes this API call to validate connectivity between Jira and Jira Align.  If you utilize an API Gateway or Reverse Proxy to connect Jira and Jira Align that requires credentials on inbound calls it will lead to this call failing as it does not send credentials. 

/rest/api/latest/issue/(issue key)


This call will return information on the referenced Jira issue such as present fields and their values, the resolution date, and current issue status.  This call is useful for determining if a field is present on a Jira issue’s screen, pulling the resolution date field name and current value, checking the status ID of an issue’s current status, and validating the type of an issue.  This call is helpful when an update did not sync from Jira to Jira Align or there is a sync error from Jira Align to Jira.  An example would be finding the current status of a Jira issue to verify its ID and the corresponding Jira to Jira Align status mapping configurations. 

/rest/api/latest/project/(project key)


This call will return information on the referenced Jira project such as its name, type, issue types, and Fix Versions.  This call is extremely useful for pulling all the Fix Versions from a Jira Project and verifying their start and release date.  When executing this API call from the API service account you can also verify that the API service account has permission access to view a particular Jira Project and access its Fix Versions.

/rest/agile/1.0/board/(board id)/sprint



This call will return information including the name, start date, end date, state, goal, and origin board ID on the sprints currently associated to a Jira Board.  This API call can assist with identifying sprints that were created in Jira than shared to the integrated Board, sprints have since been deleted in Jira, and issues with data syncing between Jira and Jira Align.  The “?StartAt=50” query parameter will be necessary to investigate all sprints when there are more than 50 sprints on a Jira Board as Jira will only return 50 sprints at a time.  This value can be shifted up or down as needed based on the number of sprints on an integrated board. 


1 comment

JiraJared Community Leader Jun 09, 2020

Great article @Tim Keyesthanks for sharing! 

Like # people like this


Log in or Sign up to comment
Community showcase
Published in Jira Align

Rockin' the Roadmap - How to make most of the Roadmap with Jira Align

The roadmap challenge for large scale agile enterprises Regardless of the agile framework you use, the agile enterprise has a massive scale with the challenge to connect hundreds of teams and thous...

2,454 views 7 24
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you