Skip to content

JIRA API

by atlassian.com

Open documentation ↗

Overview

JIRA is a proprietary issue tracking product that allows bug tracking and agile project management

JIRA is a documents & productivity API from atlassian.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 487 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Base URL
https://your-domain.atlassian.net
Version
1001.0.0-SNAPSHOT
Endpoints
487
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://your-domain.atlassian.net/rest/api/3/announcementBanner" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://your-domain.atlassian.net/rest/api/3/announcementBanner", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://your-domain.atlassian.net/rest/api/3/announcementBanner",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/rest/api/3/announcementBannerGet announcement banner configuration
PUT/rest/api/3/announcementBannerUpdate announcement banner configuration
POST/rest/api/3/app/field/valueUpdate custom fields
GET/rest/api/3/app/field/{fieldIdOrKey}/context/configurationGet custom field configurations
PUT/rest/api/3/app/field/{fieldIdOrKey}/context/configurationUpdate custom field configurations
PUT/rest/api/3/app/field/{fieldIdOrKey}/valueUpdate custom field value
GET/rest/api/3/application-propertiesGet application property
GET/rest/api/3/application-properties/advanced-settingsGet advanced settings
PUT/rest/api/3/application-properties/{id}Set application property
GET/rest/api/3/applicationroleGet all application roles
GET/rest/api/3/applicationrole/{key}Get application role
GET/rest/api/3/attachment/content/{id}Get attachment content
GET/rest/api/3/attachment/metaGet Jira attachment settings
GET/rest/api/3/attachment/thumbnail/{id}Get attachment thumbnail
GET/rest/api/3/attachment/{id}Get attachment metadata
DELETE/rest/api/3/attachment/{id}Delete attachment
GET/rest/api/3/attachment/{id}/expand/humanGet all metadata for an expanded attachment
GET/rest/api/3/attachment/{id}/expand/rawGet contents metadata for an expanded attachment
GET/rest/api/3/auditing/recordGet audit records
GET/rest/api/3/avatar/{type}/systemGet system avatars by type
POST/rest/api/3/comment/listGet comments by IDs
GET/rest/api/3/comment/{commentId}/propertiesGet comment property keys
GET/rest/api/3/comment/{commentId}/properties/{propertyKey}Get comment property
PUT/rest/api/3/comment/{commentId}/properties/{propertyKey}Set comment property
DELETE/rest/api/3/comment/{commentId}/properties/{propertyKey}Delete comment property
POST/rest/api/3/componentCreate component
GET/rest/api/3/component/{id}Get component
PUT/rest/api/3/component/{id}Update component
DELETE/rest/api/3/component/{id}Delete component
GET/rest/api/3/component/{id}/relatedIssueCountsGet component issues count
GET/rest/api/3/configurationGet global settings
GET/rest/api/3/configuration/timetrackingGet selected time tracking provider
PUT/rest/api/3/configuration/timetrackingSelect time tracking provider
GET/rest/api/3/configuration/timetracking/listGet all time tracking providers
GET/rest/api/3/configuration/timetracking/optionsGet time tracking settings
PUT/rest/api/3/configuration/timetracking/optionsSet time tracking settings
GET/rest/api/3/customFieldOption/{id}Get custom field option
GET/rest/api/3/dashboardGet all dashboards
POST/rest/api/3/dashboardCreate dashboard
GET/rest/api/3/dashboard/gadgetsGet available gadgets
GET/rest/api/3/dashboard/searchSearch for dashboards
GET/rest/api/3/dashboard/{dashboardId}/gadgetGet gadgets
POST/rest/api/3/dashboard/{dashboardId}/gadgetAdd gadget to dashboard
PUT/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}Update gadget on dashboard
DELETE/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}Remove gadget from dashboard
GET/rest/api/3/dashboard/{dashboardId}/items/{itemId}/propertiesGet dashboard item property keys
GET/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Get dashboard item property
PUT/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Set dashboard item property
DELETE/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}Delete dashboard item property
GET/rest/api/3/dashboard/{id}Get dashboard
PUT/rest/api/3/dashboard/{id}Update dashboard
DELETE/rest/api/3/dashboard/{id}Delete dashboard
POST/rest/api/3/dashboard/{id}/copyCopy dashboard
GET/rest/api/3/eventsGet events
POST/rest/api/3/expression/analyseAnalyse Jira expression
POST/rest/api/3/expression/evalEvaluate Jira expression
GET/rest/api/3/fieldGet fields
POST/rest/api/3/fieldCreate custom field
GET/rest/api/3/field/searchGet fields paginated
GET/rest/api/3/field/search/trashedGet fields in trash paginated
PUT/rest/api/3/field/{fieldId}Update custom field
GET/rest/api/3/field/{fieldId}/contextGet custom field contexts
POST/rest/api/3/field/{fieldId}/contextCreate custom field context
GET/rest/api/3/field/{fieldId}/context/defaultValueGet custom field contexts default values
PUT/rest/api/3/field/{fieldId}/context/defaultValueSet custom field contexts default values
GET/rest/api/3/field/{fieldId}/context/issuetypemappingGet issue types for custom field context
POST/rest/api/3/field/{fieldId}/context/mappingGet custom field contexts for projects and issue types
GET/rest/api/3/field/{fieldId}/context/projectmappingGet project mappings for custom field context
PUT/rest/api/3/field/{fieldId}/context/{contextId}Update custom field context
DELETE/rest/api/3/field/{fieldId}/context/{contextId}Delete custom field context
PUT/rest/api/3/field/{fieldId}/context/{contextId}/issuetypeAdd issue types to context
POST/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/removeRemove issue types from context
GET/rest/api/3/field/{fieldId}/context/{contextId}/optionGet custom field options (context)
POST/rest/api/3/field/{fieldId}/context/{contextId}/optionCreate custom field options (context)
PUT/rest/api/3/field/{fieldId}/context/{contextId}/optionUpdate custom field options (context)
PUT/rest/api/3/field/{fieldId}/context/{contextId}/option/moveReorder custom field options (context)
DELETE/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}Delete custom field options (context)
PUT/rest/api/3/field/{fieldId}/context/{contextId}/projectAssign custom field context to projects
POST/rest/api/3/field/{fieldId}/context/{contextId}/project/removeRemove custom field context from projects
GET/rest/api/3/field/{fieldId}/contextsdeprecatedGet contexts for a field
GET/rest/api/3/field/{fieldId}/screensGet screens for a field
GET/rest/api/3/field/{fieldKey}/optionGet all issue field options
POST/rest/api/3/field/{fieldKey}/optionCreate issue field option
GET/rest/api/3/field/{fieldKey}/option/suggestions/editGet selectable issue field options
GET/rest/api/3/field/{fieldKey}/option/suggestions/searchGet visible issue field options
GET/rest/api/3/field/{fieldKey}/option/{optionId}Get issue field option
PUT/rest/api/3/field/{fieldKey}/option/{optionId}Update issue field option
DELETE/rest/api/3/field/{fieldKey}/option/{optionId}Delete issue field option
DELETE/rest/api/3/field/{fieldKey}/option/{optionId}/issueReplace issue field option
DELETE/rest/api/3/field/{id}Delete custom field
POST/rest/api/3/field/{id}/restoreRestore custom field from trash
POST/rest/api/3/field/{id}/trashMove custom field to trash
GET/rest/api/3/fieldconfigurationGet all field configurations
POST/rest/api/3/fieldconfigurationCreate field configuration
PUT/rest/api/3/fieldconfiguration/{id}Update field configuration
DELETE/rest/api/3/fieldconfiguration/{id}Delete field configuration
GET/rest/api/3/fieldconfiguration/{id}/fieldsGet field configuration items
PUT/rest/api/3/fieldconfiguration/{id}/fieldsUpdate field configuration items
GET/rest/api/3/fieldconfigurationschemeGet all field configuration schemes
POST/rest/api/3/fieldconfigurationschemeCreate field configuration scheme

Showing the first 100 of 487 endpoints; the full list is in the documentation.

Questions

Does the JIRA API need an API key?

Yes. The JIRA API uses OAuth authentication; the documentation explains how to get credentials.

Does the JIRA API support HTTPS?

Yes, the JIRA API is served over HTTPS.

How many endpoints does the JIRA API have?

Its OpenAPI description lists 487 endpoints in version 1001.0.0-SNAPSHOT. The first 100 are shown on this page.

What are alternatives to the JIRA API?

Other Documents & Productivity APIs include Notion, DocStruct, Asana, ClickUp, iLovePDF.

Compare alternatives →

Listed from public-apis (MIT), public-apis database (MIT), APIs.guru (CC0).