How to get custom field in a sprint board with JIRA cloud API?

Seikyo Cho April 10, 2024

I added a field in project settings' issue types page and want to get the item by JIRA REST API.

sp.pngtask.png

I tried these APIs but didn't find the field I added.

https://my-domain.atlassian.net/rest/api/3/field
https://my-domain.atlassian.net/rest/api/3/field/1/context
https://my-domain.atlassian.net/rest/api/3/issuetype

Where can I get it?

1 answer

0 votes
David Friedrich
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.
April 11, 2024

Hi @Seikyo Cho ,

in case you do not have it, here is the link to the Jira cloud rest api documentation:
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#version

According to it (https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-group-issue-fields)
/rest/api/3/field
will give you all the fields - including the custom field you are trying to get.

This will show you the customfield ID, which you will need to get results for this specific field.
Something like customfield_10101.

An easier way to get the customfield ID is via the field configuration. If you edit a field's configuration the URL ends with something like this: ?ID=10101
That's the field's ID you can then use in your api call.

Seikyo Cho April 11, 2024

@David Friedrich 

Thank you.

I tried SP filed but didn't find it in /rest/api/3/field. However I changed to another name Test Field then found it there.

If I want to get the special custom field in one project, is there a way to set project id with field API?

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
FREE
TAGS
AUG Leaders

Atlassian Community Events