I need to query Jira Align through their v2.0 API to return a list of Programs.

[Eric Salerno]

The only mechanism I can find at this time is to query the `epics` endpoint which returns the primaryProgramId as part of the response.  This isn't adequate for my needs :(

[Edvaldo Lima]

Hi @Eric Salerno

Thanks for your question. To return a list of Programs in Jira Align, you can use the following API call using Swagger OR via the CURL command.

GET API using CURL

curl -X GET "https://<ja_instance_here>.jiraalign.com/rest/align/api/2/Programs" -H "accept: application/json;odata.metadata=minimal;odata.streaming=true" -H "Authorization: bearer <token>"

OR

GET API using Swagger

1. Go to JA > Edit Profile > API Token

2. Copy the whole content of the field API  2.0 Token

3. Go to the Swagger, present on

   • https://<ja_instance_here>.jiraalign.com/rest/align/api/docs/index.html

4. Authenticating with your Token for API v2 (that you obtained on your JA User Menu > Edit Profile > API Token)

5. Find the Programs Endpoint, select the GET method (it will be the first GET on the list), and click on Try it Now

6. Click on Execute and see if the details of it return

7. Copy the content of the request body

Should you need any help with the above instructions, please kindly raise a JA support ticket using this link and we'll be more than happy to assist you!

[Allan Maxwell]

yeah, https:xxxxx.jiraalign.com/rest/align/api/2/Programs works for me

[Eric Salerno]

Interesting, is there a version where this lights up or is there a requirement that the user account be in a certain role?  I can query `/epics/{num}` but when I hit `/programs/{num}` i get a `403` error

[Edvaldo Lima]

@Eric Salerno

The only thing I'm aware of is that for JA non-Super Admin roles, you have to make sure to enable the Programs toggle permission:

1. Login to JA
2. Navigate to Administration > Other Setup > Programs

Should you still face any issues retrieving the information via API please kindly raise a JA support ticket using this link and we'll be more than happy to assist you!

[Rodrigo Cortez]

@Eric Salerno , the rationale behind Jira Align REST API is that your bearer token is as good as your user in the UI, meaning that whatever your user can do in the UI will be allowed to your bearer token via API.

If your user can't browse to Programs in the UI, then your bearer token won't be allowed as well.