nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to call jira api in postman to get details of project, Epic, Issues and worklogs?

aagnihotri

Hi,

I am very new to JIRA and don't know much about JIRA apis. I want to get the details of all projects, all type of issues ( stories, task, epic, sub task and bugs ) and all worklogs by calling jira apis in postman. Can anyone suggest some link or way to get that done.

Thanks in advance

Accepted answers

Callum Carlile _Automation Consultants_

Hi @aagnihotri , welcome to the Atlassian Community!

First of all, you will need to create an API token, following the instructions here. Once you have this API token, for Basic Auth you can encode it using a tool such as Base64Encode, in the format of:

[email_address]:[API_Token] - you will need to use the same email address that you created the API token under. Once you have done this, you can use this in the Authorization header in postman.

So headers required would be:

Key: Content-Type Value: application/json

Key: Authorization Value: Basic [your encoded API key]

There are several API requests you can use once you have done this:

https://[your_cloud_site_name]/rest/api/2/project

This will return all projects in your site, and will include things like the project name, key, type, etc. Note: this will only return the projects that the authenticated user has Browse Issues permission for.

https://[your_cloud_site_name]/rest/api/2/project/[ProjectIdOrKey]

This would return all info related to a specific project, such as the issue types available, components, versions etc.

Worklogs is a bit trickier, I don't believe you can obtain all worklogs across all issues through the API, but if you want to find this out for a specific issue you would use

https://[your_cloud_site_name]/rest/api/2/issue/[IssueIdOrKey]/worklog

Hope this helps!

All comments

Callum Carlile _Automation Consultants_

Hi @aagnihotri , welcome to the Atlassian Community!

[email_address]:[API_Token] - you will need to use the same email address that you created the API token under. Once you have done this, you can use this in the Authorization header in postman.

So headers required would be:

Key: Content-Type Value: application/json

Key: Authorization Value: Basic [your encoded API key]

There are several API requests you can use once you have done this:

https://[your_cloud_site_name]/rest/api/2/project

https://[your_cloud_site_name]/rest/api/2/project/[ProjectIdOrKey]

This would return all info related to a specific project, such as the issue types available, components, versions etc.

Worklogs is a bit trickier, I don't believe you can obtain all worklogs across all issues through the API, but if you want to find this out for a specific issue you would use

https://[your_cloud_site_name]/rest/api/2/issue/[IssueIdOrKey]/worklog

Hope this helps!

Callum Carlile _Automation Consultants_

These would also all be GET requests^

aagnihotri

@Callum Carlile _Automation Consultants_

Hi,

Thanks for the reply. Now i am able to get all the projects but when i tried to get all issues it is returning blank

I used this api

https://solifi.atlassian.net/rest/api/2/issue

Can you please tell what am i doing wrong ?

Callum Carlile _Automation Consultants_

It doesn't exactly work in the same way for normal issues - you would need to put the issue ID or Key at the end of the request URL, which would give you all information for that particular issue.

If you use a URL of

https://[your_cloud_site_name]/rest/api/2/search?jql=

then this should return more results, though depending on how many issues you have on your instance you may hit the maximum search result (you can also just paste this url into your browser for the same result).

There's more info on this similar answer as well as this one too, but you may not be able to retrieve all data of all issues in your site if you have a large number of custom fields or issue numbers

Vinnie Pisaniello

I'm getting a 200 status ok as well, but it's not returning the projects on my site

Vinnie Pisaniello

nevermind I got it, i was missing the word "basic" in front of the token

Santhosh Nayak_yh3i4u

@Vinnie Pisaniello I'm facing similar issue. data not coming up. but status is 200
Could you please help me

aagnihotri

hi @Santhosh Nayak ,

I called the same api end point and i am getting all the projects

Screenshot 2024-06-30 141221.png

if you want to get list of all the projects then the above api endpoint is good . Please check your project permissions in jira

In the authorization you need to selct Basic Auth and in the username use your email id like abc@alpha.com. Password will be api token that you will generate in jira Screenshot 2024-06-30 141706.png

These are the headers
Screenshot 2024-06-30 141901.png

Please check these settings and if you need any help then i am happy to help you. I have been using lot of api endpoints from JIRA so it would not be tough for me to help you

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

jira

cloud

jira-software

jira-software-cloud

api

atl-gruland