The Jira Cloud platform REST API

atlassian · Developer Tools

Developer Tools No Auth Free & Open developer_tools

Jira Cloud platform REST API documentation

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get application property

Returns all application properties or an application property. If you specify a value for the `key` parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See [Set application property](#api-rest-ap

https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties?key=YOUR_API_KEY&keyFilter=example&permissionLevel=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties?key=YOUR_API_KEY&keyFilter=example&permissionLevel=example"

import requests
params = {
    "key": "YOUR_API_KEY",
    "keyFilter": "example",
    "permissionLevel": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties');
url.searchParams.set('key', 'YOUR_API_KEY');
url.searchParams.set('keyFilter', 'example');
url.searchParams.set('permissionLevel', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties")
	q := baseURL.Query()
	q.Set("key", "YOUR_API_KEY")
	q.Set("keyFilter", "example")
	q.Set("permissionLevel", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties")
uri.query = URI.encode_www_form({
  "key" => "YOUR_API_KEY",
  "keyFilter" => "example",
  "permissionLevel" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/application-properties?" . http_build_query([
    "key" => "YOUR_API_KEY",
    "keyFilter" => "example",
    "permissionLevel" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get all dashboards

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard?filter=my&startAt=0&maxResults=20

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard?filter=my&startAt=0&maxResults=20"

import requests
params = {
    "filter": "my",
    "startAt": "0",
    "maxResults": "20"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard');
url.searchParams.set('filter', 'my');
url.searchParams.set('startAt', '0');
url.searchParams.set('maxResults', '20');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard")
	q := baseURL.Query()
	q.Set("filter", "my")
	q.Set("startAt", "0")
	q.Set("maxResults", "20")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard")
uri.query = URI.encode_www_form({
  "filter" => "my",
  "startAt" => "0",
  "maxResults" => "20"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/dashboard?" . http_build_query([
    "filter" => "my",
    "startAt" => "0",
    "maxResults" => "20"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get all field configurations

Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria: * a list of field configuration item IDs. * whether the field configuration is a default. * whether the field configuratio

https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration?id=1&query=&startAt=0&isDefault=false&maxResults=50

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration?id=1&query=&startAt=0&isDefault=false&maxResults=50"

import requests
params = {
    "id": "1",
    "query": "",
    "startAt": "0",
    "isDefault": "false",
    "maxResults": "50"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration');
url.searchParams.set('id', '1');
url.searchParams.set('query', '');
url.searchParams.set('startAt', '0');
url.searchParams.set('isDefault', 'false');
url.searchParams.set('maxResults', '50');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration")
	q := baseURL.Query()
	q.Set("id", "1")
	q.Set("query", "")
	q.Set("startAt", "0")
	q.Set("isDefault", "false")
	q.Set("maxResults", "50")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration")
uri.query = URI.encode_www_form({
  "id" => "1",
  "query" => "",
  "startAt" => "0",
  "isDefault" => "false",
  "maxResults" => "50"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/atlassian.com/jira/1001.0.0-SNAPSHOT/rest/api/3/fieldconfiguration?" . http_build_query([
    "id" => "1",
    "query" => "",
    "startAt" => "0",
    "isDefault" => "false",
    "maxResults" => "50"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with The Jira Cloud platform REST API?

The Jira Cloud platform REST API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. The Jira Cloud platform REST API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗