Skip to main content
Jira logo

​
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

FieldDescriptionRequiredFormat
Client IDAtlassian OAuth App Client IDYes-
Client SecretAtlassian OAuth App Client SecretYes-

​
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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
file
string
required
A file URL to attach to the issue

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
comment
string
The comment text in plain text (converted to Atlassian Document Format)
​
body
object
The comment text in Atlassian Document Format (JSON object). Overrides comment if both provided
​
visibility
object
The group or role to which this comment is visible
​
properties
string
A JSON array of comment properties
​
additional_properties
object
Extra properties of any type to include
​
expand
string
Use ‘renderedBody’ to get comment body rendered in HTML

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
files
array
required
An array of file URLs to attach to the issue. Each element is a string URL

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
account_id
string
required
The account ID of the user to add as watcher

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddWatcherToIssueOutput",
  "type": "object"
}

​
Parameters

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
account_id
string
required
The account ID of the user to assign

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "AssignIssueOutput",
  "type": "object"
}

​
Parameters

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_ids
array
required
A list of issue IDs to check against the JQL queries. Elements are integers
​
jqls
array
required
A list of JQL query strings to check the issues against

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
jql
string
required
The JQL query to count issues. Must be bounded (e.g. project = ABC)

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
field_id
string
required
The ID of the custom field
​
context_id
string
required
The ID of the field context

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board the sprint will be created on
​
name
string
required
The name of the sprint
​
goal
string
The goal of the sprint
​
start_date
string
The start date in ISO 8601 format (e.g. 2024-01-01T00:00:00.000Z)
​
end_date
string
The end date in ISO 8601 format (e.g. 2024-01-15T00:00:00.000Z)

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
project_id
string
required
The project ID
​
issue_type_id
string
required
The issue type ID
​
update_history
boolean
Whether the project is added to the user’s Recently viewed project list
​
history_metadata
object
Additional issue history details
​
properties
string
Details of issue properties to add or update (JSON array)
​
update
object
A map of field name to operations list for issue screen fields
​
additional_properties
object
Extra fields to include in the issue body (e.g. summary, description, labels, priority)

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
project_id
string
required
The project ID
​
name
string
required
The unique name of the version. Max 255 characters
​
description
string
The description of the version
​
archived
boolean
Indicates that the version is archived
​
start_date
string
The start date (yyyy-mm-dd)
​
release_date
string
The release date (yyyy-mm-dd)
​
expand
string
Expand options: operations, issuesstatus

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
project_id
string
required
The project ID or key
​
enable_undo
boolean
required
Whether this project is placed in the Jira recycle bin for recovery

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteProjectOutput",
  "type": "object"
}

​
Parameters

​
cloud_id
string
required
The cloud ID of the Jira site
​
recent
integer
Returns the user’s most recently accessed projects (max 20)
​
properties
string
Issue properties to include (JSON array)
​
expand
string
Expand options: description, issueTypes, lead, projectKeys

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board

​
Response

{
  "$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

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
fields
string
Comma-separated list of fields to return. *all or *navigable for all or navigable fields
​
fields_by_keys
boolean
Whether fields are referenced by keys rather than IDs
​
properties
string
Issue properties to include (comma-separated or *all)
​
update_history
boolean
Whether project is added to Recently viewed
​
expand
string
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
query
string
A string to match against issue text fields
​
current_jql
string
A JQL query defining a list of issues to search within
​
current_issue_key
string
The key of an issue to exclude from results
​
current_project_id
string
The ID of a project that results must belong to
​
show_sub_tasks
boolean
Whether to include subtasks in suggestions
​
show_sub_task_parent
boolean
Whether to include the parent issue when currentIssueKey is a subtask

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
project_id
string
The project ID to filter issue types

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
sprint_id
string
required
The ID of the sprint

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
task_id
string
required
The ID of the long-running async task

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
transition_id
string
The ID of a specific transition to retrieve
​
skip_remote_only_condition
boolean
Whether transitions with Hide From User Condition are included
​
include_unavailable_transitions
boolean
Whether details of failing-condition transitions are included
​
sort_by_ops_bar_and_status
boolean
Whether transitions are sorted by ops-bar sequence then category
​
expand
string
Expand options: transitions.fields

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
account_id
string
required
The account ID of the user
​
expand
string
Expand options: groups, applicationRoles

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
query
string
Filter for a name or term

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board
​
start_at
integer
The starting index of the returned issues. Base index: 0
​
max_results
integer
The maximum number of issues to return
​
jql
string
Filters results using a JQL query
​
fields
string
Comma-separated list of fields to return per issue
​
expand
string
Expand options for additional information

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
start_at
integer
The starting index of the returned boards. Base index: 0
​
max_results
integer
The maximum number of boards to return
​
type
string
Filters by board type: scrum, kanban, simple
​
name
string
Filters results to boards matching this name
​
project_key_or_id
string
Filters results to boards relevant to a project

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board
​
epic_id
string
required
The ID of the epic
​
start_at
integer
The starting index of the returned issues. Base index: 0
​
max_results
integer
The maximum number of issues to return
​
jql
string
Filters results using a JQL query
​
fields
string
Comma-separated list of fields to return per issue
​
expand
string
Expand options for additional information

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board
​
start_at
integer
The starting index of the returned epics. Base index: 0
​
max_results
integer
The maximum number of epics to return
​
done
boolean
Filter to epics that are done or not done

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
order_by
string
Order results by a field. Valid: created, +created, -created
​
expand
string
Expand options: renderedBody

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site

​
Response

{
  "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

​
cloud_id
string
required
The cloud ID of the Jira site
​
sprint_id
string
required
The ID of the sprint
​
start_at
integer
The starting index of the returned issues. Base index: 0
​
max_results
integer
The maximum number of issues to return
​
jql
string
Filters results using a JQL query
​
fields
string
Comma-separated list of fields to return per issue
​
expand
string
Expand options for additional information

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
board_id
string
required
The ID of the board
​
start_at
integer
The starting index of the returned sprints. Base index: 0
​
max_results
integer
The maximum number of sprints to return
​
state
string
Filter by sprint states: future, active, closed (comma-separated)

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
sprint_id
string
required
The ID of the sprint
​
issues
array
required
The IDs or keys of the issues to move to the sprint. Each element is a string

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "MoveIssuesToSprintOutput",
  "type": "object"
}

​
Parameters

​
cloud_id
string
required
The cloud ID of the Jira site
​
jql
string
required
The JQL query to search for issues
​
max_results
integer
Maximum number of issues to return (default 50, max 5000)
​
fields
string
Comma-separated list of fields to return
​
expand
array
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations
​
properties
string
Comma-separated list of issue properties to include (max 5)
​
fields_by_keys
boolean
Reference fields by key rather than ID
​
fail_fast
boolean
Fail early if not all field data can be retrieved

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
jql
string
required
The JQL query to search for issues
​
max_results
integer
Maximum number of items per page
​
next_page_token
string
Token for pagination from a previous response
​
fields
array
Fields to return per issue. Elements are strings. Example: [‘summary’, ‘status’]
​
expand
array
Expand options: renderedFields, names, schema, transitions, editmeta, changelog, versionedRepresentations
​
properties
array
Issue property keys to include (max 5). Elements are strings
​
fields_by_keys
boolean
Reference fields by key rather than ID
​
reconcile_issues
array
Issue IDs/keys for read-after-write consistency. Elements are strings

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
transition
string
required
The transition ID to perform
​
fields
object
List of issue screen fields to update during transition
​
update
object
Operations to perform on issue screen fields
​
history_metadata
object
Additional issue history details
​
properties
string
Issue properties to add or update (JSON)
​
additional_properties
object
Extra properties of any type

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ],
  "title": "TransitionIssueOutput",
  "type": "object"
}

​
Parameters

​
cloud_id
string
required
The cloud ID of the Jira site
​
issue_id_or_key
string
required
The ID or key of the issue
​
comment_id
string
required
The ID of the comment to update
​
body
object
The comment text in Atlassian Document Format (JSON). Overrides comment if both provided
​
comment
string
The comment text (plain text)
​
visibility
object
The group or role to which this comment is visible
​
properties
string
Comment properties (JSON array)
​
additional_properties
object
Extra properties of any type
​
notify_users
boolean
Whether users are notified when comment is updated
​
expand
string
Expand options: renderedBody

​
Response

{
  "$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

​
cloud_id
string
required
The cloud ID of the Jira site
​
project_id
string
required
The project ID
​
issue_id_or_key
string
required
The ID or key of the issue
​
issue_type_id
string
The issue type ID
​
notify_users
boolean
Whether a notification email is sent to watchers
​
override_screen_security
boolean
Override screen security to enable hidden fields
​
override_editable_flag
boolean
Override editable flag to enable uneditable fields
​
transition_id
string
The ID of the transition to undertake
​
transition_looped
boolean
Whether the transition is looped
​
history_metadata
object
Additional issue history details
​
properties
string
Issue properties to add or update (JSON array)
​
update
object
A map of field name to operations list
​
additional_properties
object
Extra fields to update (e.g. summary, description)

​
Response

{
  "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.

Monday.com

ClickUp

Motion