Importing REST API Specs into Postman

Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.

Summary

Problem

When testing the Atlassian cloud developer documentation REST API endpoints, we're sometimes at a loss as to what and how parameters/payloads are to be populated. It's usually done on a trial-and-error basis, resulting in a waste of time and effort, until we succeed.

Diagnosis

Environment

  • Atlassian, Jira, Confluence

Diagnostic Steps

  • NA

Cause

NA

Solution

Workaround

NA

Resolution

Refer to the screenshots below with explanations:

  • Go to your desired REST API and get its OpenAPI spec URL

(Auto-migrated image: description temporarily unavailable)
  • In Postman, click on Collections, Import, Enter the OpenAPI spec URL and press Continue

(Auto-migrated image: description temporarily unavailable)

  • Click Import

(Auto-migrated image: description temporarily unavailable)

  • You can now use the pre-filled endpoint with sample fields filled

(Auto-migrated image: description temporarily unavailable)

Updated on April 2, 2025

Still need help?

The Atlassian Community is here for you.