Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Deleted user
0 / 0 points
badges earned

Your Points Tracker
  • Global
  • Feed

Badge for your thoughts?

You're enrolled in our new beta rewards program. Join our group to get the inside scoop and share your feedback.

Join group
Give the gift of kudos
You have 0 kudos available to give
Who do you want to recognize?
Why do you want to recognize them?
Great job appreciating your peers!
Check back soon to give more kudos.

Past Kudos Given
No kudos given
You haven't given any kudos yet. Share the love above and you'll see it here.

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Jira Xray: Access Test Plan Board via REST API


is it possible to access the test plan board of the Jira Xray plugin via the REST API of either Jira or Xray itself? I need to get the whole folder structure that I can create on the test plan board using the Jira GUI.

What I have seen so far is only that I can list all tests belonging to a test plan, but unstructured.

1 answer

1 accepted

1 vote
Answer accepted

I just contacted the Xray support about this and they said that this is not possible right now but already has a ticket.

However, for now my workaround is to do send a GET request to


where 'parent_folder_id' is a numeric (Xray-internal) id. Using -1 as folder id gives you the root folder. The results look like this:

"folders": [
"rank": 1,
"name": "Folder 1",
"hasChildren": false,
"id": 6,
"testCount": 1,
"totalTestCount": 1
  "rank": 2,
"name": "Folder 2",
"hasChildren": false,
"id": 7,
"testCount": 2,
"totalTestCount": 2
"rank": 3,
"name": "Folder 3",
"hasChildren": false,
"id": 8,
"testCount": 1,
"totalTestCount": 1

However, this does not seem to be part of the official API and may therefore not work with every version.

@Jonas Küper you're right.  That API endpoint is internal; it's subject to change. There are other private endpoints but they are private and not documented.

For anyone interested, please vote on the feature request .



Suggest an answer

Log in or Sign up to answer

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