Atlassian DeveloperAtlassian Developer

Atlassian DeveloperAtlassian Developer

Last updatedJun 30, 2020

Rate this page:

Using the developer documentation

The Atlassian developer documentation is here to help you build apps and customizations with our products. This page shows you where to find information on our product APIs, development frameworks, UI modules, and other resources.

Each product and deployment option has it’s own set of developer documentation, including guides, API reference, and other resources. Select a product from the Documentation dropdown to go to the documentation for that product.

After selecting your product, use the buttons at the top of the page to switch between the different sections of content.

  1. Guides describes basic concepts with tutorials to help you start building apps.
  2. Reference includes REST API, UI module, JavaScript, and tools documentation.
  3. Resources is a collection of links to the status page, developer community, platform roadmap, and other resources for developers.

Guides, Reference, and Resources navigation

Make sure you choose the right deployment option, either cloud or server, when viewing product documentation. Look for either Cloud or Server in the product name or in the page URL to double check.

Explore with guides

Each product’s documentation has a Guides section, which includes tutorials, basic concepts, security information, and other how-to’s. Guides are designed to help you start building apps and tools that extend Atlassian products:

  • See the Getting started page to set up your environment and start building Connect apps.
  • Stay up to date with each product's Latest updates or Changelog. See the Confluence changelog for an example.
  • Try more advanced tutorials and other topics for building apps.

Get the most out of APIs and reference

The Reference section includes more detailed information on REST APIs, modules, and other features. Here are some tips to help you get more out of our reference information:

  • Switch between API versions, modules, and other information at the top of the page.
  • Look for the Run in Postman button under the three dot menu to run the APIs in a testing environment. (Available for Jira, Confluence, Trello, and others.)

Guides, Reference, and Resources navigation

  • As you read through each API action, click the links in the response definitions to see detailed JSON body examples.

More resources

The resources section includes links to the developer community, status page, developer blog, and other helpful information.

Here are some other resources to keep in mind:

Rate this page: