Searching for the project by name via API

Inna S August 22, 2022

Greetings!

For one of the automation tasks I need to get a project ID.

What I have is a project name and an API.

Unfortunately, the documentation https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/#api-rest-api-3-project-search-get does not explain how to search for the project by name.

Google search does not help either.

The most funny answer was this:

jira_searchProjectIDAPI.jpg

So we spent some time experimenting and at the end found the obvious:

to find a Jira Project by NAME, use the following API call:

https://<your instance>.atlassian.net/rest/api/3/project/search?query={{ProjectName}}

where {{ProjectName}} is a custom variable you have defined in a previous step.

Enjoy.

3 answers

0 votes
robert Mugabuhamye
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
August 25, 2022

My bad @Inna S . thank you 😊🙏

0 votes
Inna S August 25, 2022

Hi @robert Mugabuhamye , the point of this post was to demonstrate how we have done the thing. 

So this is possible, just not properly documented in the API doc.

You are welcome to test for yourself.

0 votes
robert Mugabuhamye
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
August 24, 2022

Hello @Inna S ,

You can not filter by project name. You get all the projects and then you can loop in that list to find what you are looking for.

If you know the key/Id you can use it : /rest/api/3/project/{projectIdOrKey}.

Hope it helps.

Suggest an answer

Log in or Sign up to answer