API to get documentation for Jira issue

Pinchas C August 16, 2022

I can use the API - https://<domain name>/rest/api/latest/issue/<issue id> - to get the full JSON payload for a Jira issue.

Is there an API I can use to only get the text on the documentation tab for a Jira issue?

Thanks.

2 answers

1 accepted

0 votes
Answer accepted
Elmer Harms August 17, 2022

You can use the fields query parameter to select which fields should be returned by the API. If you add "&fields=key,documentationfield1,documentationfield2", the API returns just those fields.

You can find additional info on the fields parameter in the docs.

0 votes
Prince Nyeche
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 17, 2022

Are you referring to getting the value of a specific field within the Jira issue?

Suggest an answer

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

Atlassian Community Events