Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

Where is Jira API documentation?


It is really strange but is there any reference anywhere on Jira API, the one we use in Adaptavist ScriptRunner on the we or anywhere else?



Suppose I want to read a custom user property via ScriptRunner. What reference of guide should I look for?

1 answer

0 votes
Daniel Ebers Community Leader Mar 28, 2020

Hi Siavosh,

there is indeed documentation for Jira REST API (

I am not sure what you mean by your question to REST API in connection with ScriptRunner. Did you refer to Script REST Endpoints?
Documentation on this you can find here:


Hi Daniel

I don't mean the REST API. I mean the Java API. I mean this. But it looks like a bot generated listing. Not a useful practical usable reference.

The javadoc is not supposed to be a developer's guide, it's a practical usable reference doc.

If you want development guides, check the Atlassian plugin writers docs.

Thanks for your response. I have used many technical references and I can tell you the link I shared merely lists the classes and methods with the least description possible. It is more likely to be used by the API developers as I believe that is what you meant. This is the entry point for that reference. You may compare it to MS MFCQt or Python references which all provide deep and detailed explanation of the design and use of their subject. One other link I found is this page which provides some examples. Even the final reference links provided in that page lead to the javadoc we talked about.

Would you be kind and provide me a link to the Atlassian plugin writers docs you mentioned if it is different from the links I provided?

Where are Atlassian plugin writers docs?

As @Daniel Ebers pointed to -

The javadoc is minimal because there is no need for it to be complex.  I've always struggled with some of the links you've mentioned because the docs are trying to talk at every level and hence there's vast amounts of useless (to me) verbiage in there.  Docs should do one thing well, not try to be all things.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Jira

Online AMA this week: Your project management questions answered by Jira Design Lead James Rotanson

We know that great teams require amazing project management chops. It's no surprise that great teams who use Jira have strong project managers, effective workflows, and secrets that bring planning ...

190 views 1 6
Read article

Atlassian Community Events