Hi, I am trying to use the REST API to get the name of a project, given that we have its key. I am using the Get Project request. As far as I understand, I should be able to make the following request URL in order to get just the name of the project: https://my-domain.atlassian.net/rest/api/3/project/myKey?properties=name However, it just returns all of the same properties that I get if I just use that same URL without the query e.g. lead, components, issues etc. rather than just the name. I have also tried using "fields" as a query parameter in place of "properties". How can I get the API to just return a specified field only?

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; } } }

Jira REST API Get Project Name

Joseph Robbins

Hi, I am trying to use the REST API to get the name of a project, given that we have its key. I am using the Get Project request. As far as I understand, I should be able to make the following request URL in order to get just the name of the project:

<a href="https://my-domain.atlassian.net/rest/api/3/project/myKey?properties=name" target="_blank" rel="nofollow noopener noreferrer">https://my-domain.atlassian.net/rest/api/3/project/myKey?properties=name</a>

However, it just returns all of the same properties that I get if I just use that same URL without the query e.g. lead, components, issues etc. rather than just the name. I have also tried using "fields" as a query parameter in place of "properties". How can I get the API to just return a specified field only?

Accepted answers

Vikrant Yadav

Hi @Joseph Robbins Welcome to Atlassian Community!

Name is in the root of the json content. You can directly parse project name using {{name}}.

You won't get name only via API. In the application where you are using the API, you need to parse http response and get project name.

Thanks,

V.Y

All comments

Vikrant Yadav

Hi @Joseph Robbins Welcome to Atlassian Community!

Name is in the root of the json content. You can directly parse project name using {{name}}.

You won't get name only via API. In the application where you are using the API, you need to parse http response and get project name.

Thanks,

V.Y

Joseph Robbins

Ok that is fine, thanks for the quick response! My confusion came from the description of the "properties" query parameter in the api reference for "Get Project" which reads "A list of project properties to return for the project.". I am not experienced with REST so I just assumed that meant I could choose which properties the http response would contain. Thanks again.

Vikrant Yadav

You're Welcome
Glad to hear I am able 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

cloud

jira-software

jira-software-cloud

rest-api