> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Jira Integration for AI Agents & Workflows
> Atlassian Jira Cloud project tracking and issue management platform
{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}
## Overview
Add **Jira** to any ModuleX agent or workflow. Atlassian Jira Cloud project tracking and issue management integration against the Jira REST API v3 (`api.atlassian.com/ex/jira/{cloudId}/rest/api/3`) and Jira Agile API (`api.atlassian.com/ex/jira/{cloudId}/rest/agile/1.0`).
**Categories**: Project & Task Management · Project Management · Developer Tools & Infrastructure · Productivity & Collaboration · **Auth**: OAuth2 · **Actions**: 38
## Authentication
### OAuth2 Authentication
Connect using Atlassian OAuth2 (recommended)
#### Required Credentials
| Field | Description | Required | Format |
| ------------- | --------------------------------- | -------- | ------ |
| Client ID | Atlassian OAuth App Client ID | Yes | `-` |
| Client Secret | Atlassian OAuth App Client Secret | Yes | `-` |
#### OAuth Configuration
* **Authorization URL**: `https://auth.atlassian.com/authorize`
* **Token URL**: `https://auth.atlassian.com/oauth/token`
* **Scopes**: `read:jira-work`, `write:jira-work`, `read:jira-user`, `manage:jira-project`, `manage:jira-configuration`, `offline_access`
## Available Actions
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
A file URL to attach to the issue
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"filename": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filename"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mime Type"
},
"size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Size"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"required": [
"success"
],
"title": "AddAttachmentToIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The comment text in plain text (converted to Atlassian Document Format)
The comment text in Atlassian Document Format (JSON object). Overrides comment if both provided
The group or role to which this comment is visible
A JSON array of comment properties
Extra properties of any type to include
Use 'renderedBody' to get comment body rendered in HTML
### Response
```json theme={null}
{
"$defs": {
"CommentSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"body": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
}
},
"title": "CommentSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"comment": {
"anyOf": [
{
"$ref": "#/$defs/CommentSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "AddCommentToIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
An array of file URLs to attach to the issue. Each element is a string URL
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"attachments": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Attachments",
"type": "array"
}
},
"required": [
"success"
],
"title": "AddMultipleAttachmentsToIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The account ID of the user to add as watcher
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "AddWatcherToIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The account ID of the user to assign
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "AssignIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
A list of issue IDs to check against the JQL queries. Elements are integers
A list of JQL query strings to check the issues against
### Response
```json theme={null}
{
"$defs": {
"JqlMatchResult": {
"additionalProperties": false,
"properties": {
"issue_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Id"
},
"matched_jqls": {
"items": {
"type": "string"
},
"title": "Matched Jqls",
"type": "array"
}
},
"title": "JqlMatchResult",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"matches": {
"items": {
"$ref": "#/$defs/JqlMatchResult"
},
"title": "Matches",
"type": "array"
}
},
"required": [
"success"
],
"title": "CheckIssuesAgainstJqlOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The JQL query to count issues. Must be bounded (e.g. project = ABC)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
}
},
"required": [
"success"
],
"title": "CountIssuesUsingJqlOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the custom field
The ID of the field context
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"options": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Options",
"type": "array"
}
},
"required": [
"success"
],
"title": "CreateCustomFieldOptionsContextOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board the sprint will be created on
The name of the sprint
The goal of the sprint
The start date in ISO 8601 format (e.g. 2024-01-01T00:00:00.000Z)
The end date in ISO 8601 format (e.g. 2024-01-15T00:00:00.000Z)
### Response
```json theme={null}
{
"$defs": {
"SprintSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Date"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Date"
},
"complete_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Complete Date"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Goal"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "SprintSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"sprint": {
"anyOf": [
{
"$ref": "#/$defs/SprintSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateFutureSprintOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The project ID
The issue type ID
Whether the project is added to the user's Recently viewed project list
Additional issue history details
Details of issue properties to add or update (JSON array)
A map of field name to operations list for issue screen fields
Extra fields to include in the issue body (e.g. summary, description, labels, priority)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"required": [
"success"
],
"title": "CreateIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The project ID
The unique name of the version. Max 255 characters
The description of the version
Indicates that the version is archived
The start date (yyyy-mm-dd)
The release date (yyyy-mm-dd)
Expand options: operations, issuesstatus
### Response
```json theme={null}
{
"$defs": {
"VersionSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Archived"
},
"released": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Released"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Date"
},
"release_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Release Date"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "VersionSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"version": {
"anyOf": [
{
"$ref": "#/$defs/VersionSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CreateVersionOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The project ID or key
Whether this project is placed in the Jira recycle bin for recovery
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "DeleteProjectOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
Returns the user's most recently accessed projects (max 20)
Issue properties to include (JSON array)
Expand options: description, issueTypes, lead, projectKeys
### Response
```json theme={null}
{
"$defs": {
"ProjectSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"project_type_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Type Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "ProjectSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"projects": {
"items": {
"$ref": "#/$defs/ProjectSummary"
},
"title": "Projects",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
}
},
"required": [
"success"
],
"title": "GetAllProjectsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board
### Response
```json theme={null}
{
"$defs": {
"BoardSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"board_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Board Type"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "BoardSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"board": {
"anyOf": [
{
"$ref": "#/$defs/BoardSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetBoardOutput",
"type": "object"
}
```
### Response
```json theme={null}
{
"$defs": {
"CloudSite": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"scopes": {
"items": {
"type": "string"
},
"title": "Scopes",
"type": "array"
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar Url"
}
},
"title": "CloudSite",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"sites": {
"items": {
"$ref": "#/$defs/CloudSite"
},
"title": "Sites",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetCloudIdOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
### Response
```json theme={null}
{
"$defs": {
"UserSummary": {
"additionalProperties": false,
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar Url"
},
"account_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Type"
}
},
"title": "UserSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"user": {
"anyOf": [
{
"$ref": "#/$defs/UserSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetCurrentUserOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
Comma-separated list of fields to return. \*all or \*navigable for all or navigable fields
Whether fields are referenced by keys rather than IDs
Issue properties to include (comma-separated or \*all)
Whether project is added to Recently viewed
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issue": {
"anyOf": [
{
"$ref": "#/$defs/IssueSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
A string to match against issue text fields
A JQL query defining a list of issues to search within
The key of an issue to exclude from results
The ID of a project that results must belong to
Whether to include subtasks in suggestions
Whether to include the parent issue when currentIssueKey is a subtask
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
},
"SuggestionSection": {
"additionalProperties": false,
"properties": {
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Label"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
}
},
"title": "SuggestionSection",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"sections": {
"items": {
"$ref": "#/$defs/SuggestionSection"
},
"title": "Sections",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetIssuePickerSuggestionsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The project ID to filter issue types
### Response
```json theme={null}
{
"$defs": {
"IssueTypeSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"subtask": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Subtask"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "IssueTypeSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issue_types": {
"items": {
"$ref": "#/$defs/IssueTypeSummary"
},
"title": "Issue Types",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetIssueTypesOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the sprint
### Response
```json theme={null}
{
"$defs": {
"SprintSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Date"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Date"
},
"complete_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Complete Date"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Goal"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "SprintSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"sprint": {
"anyOf": [
{
"$ref": "#/$defs/SprintSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetSprintOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the long-running async task
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"progress": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Progress"
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Result"
},
"task_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Task Id"
}
},
"required": [
"success"
],
"title": "GetTaskOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The ID of a specific transition to retrieve
Whether transitions with Hide From User Condition are included
Whether details of failing-condition transitions are included
Whether transitions are sorted by ops-bar sequence then category
Expand options: transitions.fields
### Response
```json theme={null}
{
"$defs": {
"TransitionSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"to_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "To Status"
},
"has_screen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has Screen"
}
},
"title": "TransitionSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"transitions": {
"items": {
"$ref": "#/$defs/TransitionSummary"
},
"title": "Transitions",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetTransitionsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The account ID of the user
Expand options: groups, applicationRoles
### Response
```json theme={null}
{
"$defs": {
"UserSummary": {
"additionalProperties": false,
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar Url"
},
"account_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Type"
}
},
"title": "UserSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"user": {
"anyOf": [
{
"$ref": "#/$defs/UserSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "GetUserOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
Filter for a name or term
### Response
```json theme={null}
{
"$defs": {
"UserSummary": {
"additionalProperties": false,
"properties": {
"account_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Id"
},
"display_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"email_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Address"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Avatar Url"
},
"account_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Account Type"
}
},
"title": "UserSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"users": {
"items": {
"$ref": "#/$defs/UserSummary"
},
"title": "Users",
"type": "array"
}
},
"required": [
"success"
],
"title": "GetUsersOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board
The starting index of the returned issues. Base index: 0
The maximum number of issues to return
Filters results using a JQL query
Comma-separated list of fields to return per issue
Expand options for additional information
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListBoardIssuesOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The starting index of the returned boards. Base index: 0
The maximum number of boards to return
Filters by board type: scrum, kanban, simple
Filters results to boards matching this name
Filters results to boards relevant to a project
### Response
```json theme={null}
{
"$defs": {
"BoardSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"board_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Board Type"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "BoardSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"boards": {
"items": {
"$ref": "#/$defs/BoardSummary"
},
"title": "Boards",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListBoardsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board
The ID of the epic
The starting index of the returned issues. Base index: 0
The maximum number of issues to return
Filters results using a JQL query
Comma-separated list of fields to return per issue
Expand options for additional information
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListEpicIssuesOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board
The starting index of the returned epics. Base index: 0
The maximum number of epics to return
Filter to epics that are done or not done
### Response
```json theme={null}
{
"$defs": {
"EpicSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"done": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Done"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "EpicSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"epics": {
"items": {
"$ref": "#/$defs/EpicSummary"
},
"title": "Epics",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListEpicsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
Order results by a field. Valid: created, +created, -created
Expand options: renderedBody
### Response
```json theme={null}
{
"$defs": {
"CommentSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"body": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
}
},
"title": "CommentSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"comments": {
"items": {
"$ref": "#/$defs/CommentSummary"
},
"title": "Comments",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListIssueCommentsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"labels": {
"items": {
"type": "string"
},
"title": "Labels",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
}
},
"required": [
"success"
],
"title": "ListLabelsOptionsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the sprint
The starting index of the returned issues. Base index: 0
The maximum number of issues to return
Filters results using a JQL query
Comma-separated list of fields to return per issue
Expand options for additional information
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListSprintIssuesOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the board
The starting index of the returned sprints. Base index: 0
The maximum number of sprints to return
Filter by sprint states: future, active, closed (comma-separated)
### Response
```json theme={null}
{
"$defs": {
"SprintSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Date"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "End Date"
},
"complete_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Complete Date"
},
"goal": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Goal"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
}
},
"title": "SprintSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"sprints": {
"items": {
"$ref": "#/$defs/SprintSummary"
},
"title": "Sprints",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "ListSprintsOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID of the sprint
The IDs or keys of the issues to move to the sprint. Each element is a string
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "MoveIssuesToSprintOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The JQL query to search for issues
Maximum number of issues to return (default 50, max 5000)
Comma-separated list of fields to return
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations
Comma-separated list of issue properties to include (max 5)
Reference fields by key rather than ID
Fail early if not all field data can be retrieved
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"start_at": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Start At"
},
"max_results": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Max Results"
}
},
"required": [
"success"
],
"title": "SearchIssuesWithJqlOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The JQL query to search for issues
Maximum number of items per page
Token for pagination from a previous response
Fields to return per issue. Elements are strings. Example: \['summary', 'status']
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations
Issue property keys to include (max 5). Elements are strings
Reference fields by key rather than ID
Issue IDs/keys for read-after-write consistency. Elements are strings
### Response
```json theme={null}
{
"$defs": {
"IssueSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Key"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Summary"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"issue_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue Type"
},
"priority": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"assignee": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignee"
},
"reporter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reporter"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
},
"fields": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Fields"
}
},
"title": "IssueSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/$defs/IssueSummary"
},
"title": "Issues",
"type": "array"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
},
"next_page_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Page Token"
}
},
"required": [
"success"
],
"title": "SearchIssuesWithJqlPostOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The transition ID to perform
List of issue screen fields to update during transition
Operations to perform on issue screen fields
Additional issue history details
Issue properties to add or update (JSON)
Extra properties of any type
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "TransitionIssueOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The ID or key of the issue
The ID of the comment to update
The comment text in Atlassian Document Format (JSON). Overrides comment if both provided
The comment text (plain text)
The group or role to which this comment is visible
Comment properties (JSON array)
Extra properties of any type
Whether users are notified when comment is updated
Expand options: renderedBody
### Response
```json theme={null}
{
"$defs": {
"CommentSummary": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"self_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Self Url"
},
"body": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"author": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author"
},
"created": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Updated"
}
},
"title": "CommentSummary",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"comment": {
"anyOf": [
{
"$ref": "#/$defs/CommentSummary"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "UpdateCommentOutput",
"type": "object"
}
```
### Parameters
The cloud ID of the Jira site
The project ID
The ID or key of the issue
The issue type ID
Whether a notification email is sent to watchers
Override screen security to enable hidden fields
Override editable flag to enable uneditable fields
The ID of the transition to undertake
Whether the transition is looped
Additional issue history details
Issue properties to add or update (JSON array)
A map of field name to operations list
Extra fields to update (e.g. summary, description)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
}
},
"required": [
"success"
],
"title": "UpdateIssueOutput",
"type": "object"
}
```
## Limits & Quotas
* **Standard rate limit**: Jira Cloud REST API allows approximately 100 requests per 10 seconds per user per app.
* **Concurrent requests**: Maximum 10 concurrent requests per user per app.
* **Search (JQL)**: Maximum 5000 results per search request.
* **Attachments**: Maximum 10 MB per file (default; configurable by site admin).
* **Error model**: non-2xx responses raise `httpx.HTTPStatusError` (Pattern A). The error includes the status code and response body for debugging.
## Related integrations
## Links
* [Jira](https://www.atlassian.com/software/jira)