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
- Category
- Documents & Productivity
- Base URL
https://your-domain.atlassian.net- Version
- 1001.0.0-SNAPSHOT
- Endpoints
- 487
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://your-domain.atlassian.net/rest/api/3/announcementBanner" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"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);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
| Method | Path | What it does |
|---|---|---|
| GET | /rest/api/3/announcementBanner | Get announcement banner configuration |
| PUT | /rest/api/3/announcementBanner | Update announcement banner configuration |
| POST | /rest/api/3/app/field/value | Update custom fields |
| GET | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Get custom field configurations |
| PUT | /rest/api/3/app/field/{fieldIdOrKey}/context/configuration | Update custom field configurations |
| PUT | /rest/api/3/app/field/{fieldIdOrKey}/value | Update custom field value |
| GET | /rest/api/3/application-properties | Get application property |
| GET | /rest/api/3/application-properties/advanced-settings | Get advanced settings |
| PUT | /rest/api/3/application-properties/{id} | Set application property |
| GET | /rest/api/3/applicationrole | Get 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/meta | Get 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/human | Get all metadata for an expanded attachment |
| GET | /rest/api/3/attachment/{id}/expand/raw | Get contents metadata for an expanded attachment |
| GET | /rest/api/3/auditing/record | Get audit records |
| GET | /rest/api/3/avatar/{type}/system | Get system avatars by type |
| POST | /rest/api/3/comment/list | Get comments by IDs |
| GET | /rest/api/3/comment/{commentId}/properties | Get 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/component | Create 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}/relatedIssueCounts | Get component issues count |
| GET | /rest/api/3/configuration | Get global settings |
| GET | /rest/api/3/configuration/timetracking | Get selected time tracking provider |
| PUT | /rest/api/3/configuration/timetracking | Select time tracking provider |
| GET | /rest/api/3/configuration/timetracking/list | Get all time tracking providers |
| GET | /rest/api/3/configuration/timetracking/options | Get time tracking settings |
| PUT | /rest/api/3/configuration/timetracking/options | Set time tracking settings |
| GET | /rest/api/3/customFieldOption/{id} | Get custom field option |
| GET | /rest/api/3/dashboard | Get all dashboards |
| POST | /rest/api/3/dashboard | Create dashboard |
| GET | /rest/api/3/dashboard/gadgets | Get available gadgets |
| GET | /rest/api/3/dashboard/search | Search for dashboards |
| GET | /rest/api/3/dashboard/{dashboardId}/gadget | Get gadgets |
| POST | /rest/api/3/dashboard/{dashboardId}/gadget | Add 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}/properties | Get 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}/copy | Copy dashboard |
| GET | /rest/api/3/events | Get events |
| POST | /rest/api/3/expression/analyse | Analyse Jira expression |
| POST | /rest/api/3/expression/eval | Evaluate Jira expression |
| GET | /rest/api/3/field | Get fields |
| POST | /rest/api/3/field | Create custom field |
| GET | /rest/api/3/field/search | Get fields paginated |
| GET | /rest/api/3/field/search/trashed | Get fields in trash paginated |
| PUT | /rest/api/3/field/{fieldId} | Update custom field |
| GET | /rest/api/3/field/{fieldId}/context | Get custom field contexts |
| POST | /rest/api/3/field/{fieldId}/context | Create custom field context |
| GET | /rest/api/3/field/{fieldId}/context/defaultValue | Get custom field contexts default values |
| PUT | /rest/api/3/field/{fieldId}/context/defaultValue | Set custom field contexts default values |
| GET | /rest/api/3/field/{fieldId}/context/issuetypemapping | Get issue types for custom field context |
| POST | /rest/api/3/field/{fieldId}/context/mapping | Get custom field contexts for projects and issue types |
| GET | /rest/api/3/field/{fieldId}/context/projectmapping | Get 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}/issuetype | Add issue types to context |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove | Remove issue types from context |
| GET | /rest/api/3/field/{fieldId}/context/{contextId}/option | Get custom field options (context) |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/option | Create custom field options (context) |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/option | Update custom field options (context) |
| PUT | /rest/api/3/field/{fieldId}/context/{contextId}/option/move | Reorder 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}/project | Assign custom field context to projects |
| POST | /rest/api/3/field/{fieldId}/context/{contextId}/project/remove | Remove custom field context from projects |
| GET | /rest/api/3/field/{fieldId}/contextsdeprecated | Get contexts for a field |
| GET | /rest/api/3/field/{fieldId}/screens | Get screens for a field |
| GET | /rest/api/3/field/{fieldKey}/option | Get all issue field options |
| POST | /rest/api/3/field/{fieldKey}/option | Create issue field option |
| GET | /rest/api/3/field/{fieldKey}/option/suggestions/edit | Get selectable issue field options |
| GET | /rest/api/3/field/{fieldKey}/option/suggestions/search | Get 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}/issue | Replace issue field option |
| DELETE | /rest/api/3/field/{id} | Delete custom field |
| POST | /rest/api/3/field/{id}/restore | Restore custom field from trash |
| POST | /rest/api/3/field/{id}/trash | Move custom field to trash |
| GET | /rest/api/3/fieldconfiguration | Get all field configurations |
| POST | /rest/api/3/fieldconfiguration | Create 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}/fields | Get field configuration items |
| PUT | /rest/api/3/fieldconfiguration/{id}/fields | Update field configuration items |
| GET | /rest/api/3/fieldconfigurationscheme | Get all field configuration schemes |
| POST | /rest/api/3/fieldconfigurationscheme | Create 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.
Similar documents & productivity APIs
Compare alternatives →Notion
Documents & ProductivityIntegrate with Notion
DocStruct
Documents & ProductivityAI extraction of invoices, receipts, bank statements & contracts into structured JSON/CSV
Asana
Documents & ProductivityProgrammatic access to all data in your asana system
ClickUp
Documents & ProductivityClickUp is a robust, cloud-based project management tool for boosting productivity
iLovePDF
Documents & ProductivityConvert, merge, split, extract text and add page numbers for PDFs. Free for 250 documents/month
Airtable
Documents & ProductivityIntegrate with Airtable
Listed from public-apis (MIT), public-apis database (MIT), APIs.guru (CC0).