{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Issues API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Issues", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Component for Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/components/:component_id", "params": [ { "name": "component_id", "value": "", "type": "path", "description": "The component's id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves detailed information about a specific component within a Bitbucket repository's issue tracking system. By providing the workspace identifier, repository slug, and component ID in the endpoint path, users can fetch metadata and configuration details for that particular component, which is typically used to categorize and organize issues within the repository. Components help teams structure their issue tracking by grouping related issues together, such as by feature a" }, { "info": { "name": "Atlassian List Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The List Issues operation retrieves all issues associated with a specific Bitbucket repository within a workspace. By making a GET request to this endpoint with the workspace ID and repository slug as path parameters, users can access a paginated list of issues including their metadata such as title, description, status, priority, assignee, and creation date. This endpoint supports various query parameters for filtering and sorting issues, making it useful for integrating issue tracking data int" }, { "info": { "name": "Atlassian Create an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new issue in the specified Bitbucket repository within a workspace. This POST endpoint allows users to submit issue details such as title, description, priority, and other metadata to track bugs, tasks, or feature requests. The operation requires authentication and appropriate repository permissions, with the workspace and repository slug specified in the URL path to identify the target repository where the issue will be created." }, { "info": { "name": "Atlassian Export Issues", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/export", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "The Export Issues endpoint allows users to trigger an export of all issues from a specific repository in Bitbucket. This POST operation is accessed via the path /repositories/{workspace}/{repo_slug}/issues/export, where workspace identifies the Bitbucket workspace and repo_slug specifies the repository containing the issues to be exported. When invoked, this API initiates an asynchronous export process that generates a downloadable file containing issue data from the repository, which can be use" }, { "info": { "name": "Atlassian Check Issue Export Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/export/:repo_name-issues-:task_id.zip", "params": [ { "name": "repo_name", "value": "", "type": "path", "description": "The name of the repo" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "task_id", "value": "", "type": "path", "description": "The ID of the export task" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation checks the status of a previously initiated issue export request for a specific Bitbucket repository by polling the export endpoint using the provided task ID. When called, it queries the export job identified by the workspace, repository slug, repository name, and unique task identifier to determine whether the export process is still running, has completed successfully, or has failed. If the export is complete, the endpoint returns the ZIP file containing the exported issues" }, { "info": { "name": "Atlassian Check Issue Import Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/import", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows you to check the status of a bulk issue import operation for a specific Bitbucket repository. By making a GET request to `/repositories/{workspace}/{repo_slug}/issues/import`, you can retrieve information about a previously initiated issue import process, including whether it's still in progress, completed successfully, or encountered any errors. The endpoint requires you to specify both the workspace identifier and the repository slug in the URL path, and it returns det" }, { "info": { "name": "Atlassian Import Issues", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/import", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows users to import issues in bulk to a Bitbucket repository by sending a POST request to /repositories/{workspace}/{repo_slug}/issues/import. It requires specifying the workspace identifier and repository slug in the URL path, and is designed to facilitate the migration or mass creation of issues from external sources or other issue tracking systems into a Bitbucket repository's issue tracker. The endpoint accepts issue data in the request body and processes multiple issues" }, { "info": { "name": "Atlassian Get an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves detailed information about a specific issue from a Bitbucket repository by providing the workspace identifier, repository slug, and issue ID as path parameters. It returns comprehensive data about the requested issue including its title, description, status, priority, assignee, reporter, creation and update timestamps, comments, and other metadata associated with the issue. This endpoint is useful for developers and project managers who need to fetch complete details" }, { "info": { "name": "Atlassian Delete an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to permanently delete a specific issue from a Bitbucket repository by sending a DELETE request to the endpoint with the workspace identifier, repository slug, and issue ID as path parameters. When executed successfully, it removes the issue and all associated data from the repository's issue tracker, making it an irreversible action that should be used with caution. The operation requires appropriate permissions within the workspace and repository to perform the del" }, { "info": { "name": "Atlassian List Attachments for an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/attachments", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all attachments for the specified issue in a Bitbucket repository. This GET endpoint accepts a workspace identifier, repository slug, and issue ID as path parameters to retrieve metadata and download URLs for all files that have been attached to that particular issue. The response includes details such as attachment names, sizes, content types, and links to access each file, making it useful for displaying or downloading issue-related documents, images, or other supporting files programm" }, { "info": { "name": "Atlassian Upload an Attachment to an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/attachments", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows users to upload file attachments to a specific issue within a Bitbucket repository by making a POST request to the path /repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments, where {workspace} represents the Bitbucket workspace identifier, {repo_slug} is the repository's unique identifier, and {issue_id} is the specific issue number to which the attachment will be added. The operation requires the file to be sent as multipart/form-data in the request body, " }, { "info": { "name": "Atlassian Get Attachment for an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/attachments/:path", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "path", "value": "", "type": "path", "description": "Path to the file." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a specific attachment file associated with an issue in a Bitbucket repository by providing the workspace identifier, repository slug, issue ID, and the path to the attachment file. When called, it returns the binary content of the requested attachment, allowing users to download or access files that have been previously uploaded to an issue, such as screenshots, logs, or other supporting documentation that help describe or troubleshoot the reported issue." }, { "info": { "name": "Atlassian Delete an Attachment for an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/attachments/:path", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "path", "value": "", "type": "path", "description": "Path to the file." }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to delete a specific attachment from an issue in a Bitbucket repository by providing the workspace identifier, repository slug, issue ID, and the path or filename of the attachment you wish to remove. When executed, it permanently removes the designated file attachment that was previously uploaded to the specified issue, helping to manage and maintain issue-related documentation and files within your Bitbucket workspace. The operation requires appropriate permission" }, { "info": { "name": "Atlassian List Changes on an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/changes", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details." }, { "name": "sort", "value": "", "type": "query", "description": "\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all the issue changes that were made on the specified issue. This endpoint retrieves the complete change history for a particular issue in a Bitbucket repository, allowing you to track modifications such as status updates, assignee changes, priority adjustments, and other field modifications over time. The response includes details about who made each change, when it occurred, and what specifically was altered, providing full audit trail capabilities for issue tracking and management wit" }, { "info": { "name": "Atlassian Modify the State of an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/changes", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This POST operation allows you to modify the state of a specific issue within a Bitbucket repository by submitting change requests to the issue's change log. The endpoint requires three path parameters: the workspace identifier, the repository slug, and the issue ID you want to update. When called, it creates a new change entry that can update various issue properties such as status, priority, assignee, or other configurable fields depending on your repository's issue tracker settings. This oper" }, { "info": { "name": "Atlassian Get Issue Change Object", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/changes/:change_id", "params": [ { "name": "change_id", "value": "", "type": "path", "description": "The issue change id" }, { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET endpoint retrieves a specific change object associated with an issue in a Bitbucket repository, allowing users to examine the detailed history of modifications made to a particular issue. By providing the workspace identifier, repository slug, issue ID, and change ID in the URL path, the API returns comprehensive information about a single change event, including what was modified, when the change occurred, and who made the modification. This is particularly useful for tracking issue ev" }, { "info": { "name": "Atlassian List Comments on an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" }, { "name": "q", "value": "", "type": "query", "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves all comments associated with a specific issue in a Bitbucket repository. By providing the workspace identifier, repository slug, and issue ID as path parameters, the endpoint returns a paginated list of comments that have been posted on that particular issue. The response includes comment metadata such as the comment content, author information, creation and update timestamps, and any related links. This is useful for developers and project managers who need to revie" }, { "info": { "name": "Atlassian Create Comment on an Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new comment on the specified issue in a Bitbucket repository. This POST endpoint requires authentication and targets a specific issue within a repository by providing the workspace identifier, repository slug, and issue ID in the URL path. The request body should contain the comment content and any additional metadata according to Bitbucket's comment schema. Upon successful execution, the API returns the newly created comment object including its unique identifier, author information, " }, { "info": { "name": "Atlassian Get Comment on an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "The id of the comment." }, { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation retrieves a specific comment from an issue within a Bitbucket repository by providing the workspace identifier, repository slug, issue ID, and comment ID in the endpoint path. It returns detailed information about the comment including its content, author, creation date, modification history, and any associated metadata. This GET request is useful for accessing individual comment details without fetching all comments on an issue, enabling efficient retrieval of specific discus" }, { "info": { "name": "Atlassian Update Comment on an Issue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "The id of the comment." }, { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This PUT operation updates an existing comment on a specific issue within a Bitbucket repository. By providing the workspace identifier, repository slug, issue ID, and comment ID in the URL path, users can modify the content of a previously posted comment. The request requires authentication and appropriate permissions to edit the comment, typically limited to the comment's original author or users with administrative privileges. The operation accepts updated comment data in the request body and" }, { "info": { "name": "Atlassian Delete Comment on an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/comments/:comment_id", "params": [ { "name": "comment_id", "value": "", "type": "path", "description": "The id of the comment." }, { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to delete a specific comment from an issue in a Bitbucket repository. By sending a DELETE request to the endpoint with the workspace ID, repository slug, issue ID, and comment ID, you can permanently remove a comment that was previously added to an issue. This is useful for removing outdated, incorrect, or inappropriate comments from issue discussions. The authenticated user must have appropriate permissions to delete the comment, typically requiring either ownershi" }, { "info": { "name": "Atlassian Check if Current User Voted for an Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/vote", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET endpoint checks whether the currently authenticated user has voted for a specific issue in a Bitbucket repository. By providing the workspace identifier, repository slug, and issue ID in the URL path, the API returns the voting status of the authenticated user for that particular issue. This operation is useful for applications that need to display voting state or manage user interactions with repository issues, allowing developers to determine if a user has already cast their vote befo" }, { "info": { "name": "Atlassian Vote for an Issue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/vote", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows authenticated users to cast a vote in support of a specific issue within a Bitbucket repository. By sending a PUT request to this endpoint with the appropriate workspace identifier, repository slug, and issue ID, users can register their interest or priority for a particular issue, helping repository maintainers understand which issues are most important to the community. The voting mechanism is commonly used to gauge user sentiment and prioritize bug fixes or feature re" }, { "info": { "name": "Atlassian Remove Vote for an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/vote", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API operation allows you to remove your vote from a specific issue in a Bitbucket repository. By sending a DELETE request to the endpoint with the workspace identifier, repository slug, and issue ID, you can retract a previously cast vote on that issue. This is useful when you no longer wish to express support or priority for a particular issue, effectively decreasing its vote count and potentially affecting its perceived importance or ranking within the project's issue tracker." }, { "info": { "name": "Atlassian Check if Current User Is Watching Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/watch", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET endpoint allows you to check whether the currently authenticated user is watching a specific issue in a Bitbucket repository. By making a request to this endpoint with the workspace ID, repository slug, and issue ID, you'll receive a response indicating the watch status of the authenticated user for that particular issue. This is useful for applications that need to determine if a user has subscribed to receive notifications about updates, comments, or changes to a specific issue, enabl" }, { "info": { "name": "Atlassian Watch an Issue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/watch", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint allows authenticated users to start watching a specific issue in a Bitbucket repository by sending a PUT request to the specified path with the workspace identifier, repository slug, and issue ID. When executed successfully, the user will receive notifications about subsequent changes, comments, and updates to that particular issue. This is useful for staying informed about issues that are relevant to a user's work or interests without needing to manually check for updates. The" }, { "info": { "name": "Atlassian Stop Watching an Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/issues/:issue_id/watch", "params": [ { "name": "issue_id", "value": "", "type": "path", "description": "The issue id" }, { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes the authenticated user's watch status from a specific issue in a Bitbucket repository. This endpoint allows users to unsubscribe from notifications and updates related to a particular issue they were previously watching. By sending a DELETE request to this endpoint with the workspace identifier, repository slug, and issue ID, the user will no longer receive notifications when the issue is updated, commented on, or changes status. This is useful for managing notification preferences and r" }, { "info": { "name": "Atlassian List Defined Versions for Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/versions", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API endpoint retrieves a paginated list of all defined versions associated with a specific repository in Bitbucket. By making a GET request to /repositories/{workspace}/{repo_slug}/versions, users can access version information that is typically used for issue tracking and release management within the repository. The endpoint requires two path parameters: the workspace identifier and the repository slug, which together uniquely identify the target repository. The response returns version o" }, { "info": { "name": "Atlassian Get Defined Version for Issues", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/versions/:version_id", "params": [ { "name": "repo_slug", "value": "", "type": "path", "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n" }, { "name": "version_id", "value": "", "type": "path", "description": "The version's id" }, { "name": "workspace", "value": "", "type": "path", "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This GET operation retrieves a specific defined version for issues within a Bitbucket repository by accessing the endpoint /repositories/{workspace}/{repo_slug}/versions/{version_id}. It requires three path parameters: the workspace identifier, the repository slug (a URL-friendly repository name), and the version_id of the specific version you want to retrieve. This endpoint is useful for fetching detailed information about a particular version or milestone that has been configured for issue tra" }, { "info": { "name": "Atlassian Archive Issue S By Jql", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/archive", "body": { "type": "json", "data": "{}" } }, "docs": "Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status of the submitted request.

You can use the [get task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) and [cancel task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) APIs to manage the request.

**Note that:**

* you can't archive s" }, { "info": { "name": "Atlassian Archive Issue S By Issue Id Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/archive", "body": { "type": "json", "data": "{}" } }, "docs": "Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) archived in the process and the errors encountered, if any.

**Note that:**

* you can't archive subtasks directly, only through their parent issues
* you can only archive issues from software, service management, and business projects

**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com" }, { "info": { "name": "Atlassian Bulk Create Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Creates upto **50** issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.

The content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appe" }, { "info": { "name": "Atlassian Get Create Issue Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/createmeta", "params": [ { "name": "projectIds", "value": "", "type": "query", "description": "List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, `projectIds=10000,10001&projectIds=10020,10021`. This parameter may be provided with `projectKeys`." }, { "name": "projectKeys", "value": "", "type": "query", "description": "List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, `projectKeys=proj1,proj2&projectKeys=proj3`. This parameter may be provided with `projectIds`." }, { "name": "issuetypeIds", "value": "", "type": "query", "description": "List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, `issuetypeIds=10000,10001&issuetypeIds=10020,10021`. This parameter may be provided with `issuetypeNames`." }, { "name": "issuetypeNames", "value": "", "type": "query", "description": "List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, `issuetypeNames=name1,name2&issuetypeNames=name3`. This parameter may be provided with `issuetypeIds`." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about issue metadata in the response. This parameter accepts `projects.issuetypes.fields`, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the `fields` and `update` fields in [Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post)." } ] }, "docs": "Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).

The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations r" }, { "info": { "name": "Atlassian Get Create Metadata Issue Types For A Project", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/createmeta/:projectIdOrKey/issuetypes", "params": [ { "name": "projectIdOrKey", "value": "", "type": "path", "description": "The ID or key of the project." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects." }, { "info": { "name": "Atlassian Get Create Field Metadata For A Project And Issue Type Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/createmeta/:projectIdOrKey/issuetypes/:issueTypeId", "params": [ { "name": "projectIdOrKey", "value": "", "type": "path", "description": "The ID or key of the project." }, { "name": "issueTypeId", "value": "", "type": "path", "description": "The issuetype ID." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects." }, { "info": { "name": "Atlassian Unarchive Issue S By Issue Keys Id", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/unarchive", "body": { "type": "json", "data": "{}" } }, "docs": "Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the issue(s) unarchived in the process and the errors encountered, if any.

**Note that:**

* you can't unarchive subtasks directly, only through their parent issues
* you can only unarchive issues from software, service management, and business projects

**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlas" }, { "info": { "name": "Atlassian Get Issue", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "fields", "value": "", "type": "query", "description": "A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n * `summary,comment` Returns only the summary and comments fields.\n * `-description` Returns all (default) fields except description.\n * `*navigable,-comment` Returns all navigable fields except comment.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`.\n\nNote: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields." }, { "name": "fieldsByKeys", "value": "", "type": "query", "description": "Whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored." }, { "name": "properties", "value": "", "type": "query", "description": "A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:\n\n * `*all` Returns all issue properties.\n * Any issue property key, prefixed with a minus to exclude.\n\nExamples:\n\n * `*all` Returns all properties.\n * `*all,-prop1` Returns all properties except `prop1`.\n * `prop1,prop2` Returns `prop1` and `prop2` properties.\n\nThis parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`." }, { "name": "updateHistory", "value": "", "type": "query", "description": "Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) `lastViewed` field." } ] }, "docs": "Returns the details for an issue.

The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* " }, { "info": { "name": "Atlassian Edit Issue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "notifyUsers", "value": "", "type": "query", "description": "Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored." }, { "name": "overrideScreenSecurity", "value": "", "type": "query", "description": "Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "name": "returnIssue", "value": "", "type": "query", "description": "Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get)." }, { "name": "expand", "value": "", "type": "query", "description": "The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits an issue. A transition may be applied and issue properties updated as part of the edit.

The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).

The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting `update.parent.set.none` to *true*. Note that the `description`, `environment`, and an" }, { "info": { "name": "Atlassian Delete Issue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "deleteSubtasks", "value": "", "type": "query", "description": "Whether the issue's subtasks are deleted when the issue is deleted." } ] }, "docs": "Deletes an issue.

An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be deleted with the issue.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confl" }, { "info": { "name": "Atlassian Assign Issue", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/assignee", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue to be assigned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns an issue to a user. Use this operation when the calling user does not have the *Edit Issues* permission but has the *Assign issue* permission for the project that the issue is in.

If `name` or `accountId` is set to:

* `\"-1\"`, the issue is assigned to the default assignee for the project.
* `null`, the issue is set to unassigned.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse Projects* and *Assign" }, { "info": { "name": "Atlassian Get Changelogs", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/changelog", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." } ] }, "docs": "Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, { "info": { "name": "Atlassian Get Changelogs By Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/changelog/list", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns changelogs for an issue specified by a list of changelog IDs.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:**

* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, { "info": { "name": "Atlassian Get Edit Issue Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/editmeta", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "overrideScreenSecurity", "value": "", "type": "query", "description": "Whether hidden fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "name": "overrideEditableFlag", "value": "", "type": "query", "description": "Whether non-editable fields are returned. Available to Connect app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ] }, "docs": "Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put).

This endpoint will check for these conditions:

1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type scheme configuration. `overrideScreenSecurity=true` skips this condition.
2. Field is visible in the [field configuration](https" }, { "info": { "name": "Atlassian Send Notification For Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/notify", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "ID or key of the issue that the notification is sent for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an email notification for an issue and adds it to the mail queue.

**[Permissions](#permissions) required:**

* *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, { "info": { "name": "Atlassian Get Transitions", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/transitions", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts `transitions.fields`, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the `fields` and `update` fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post)." }, { "name": "transitionId", "value": "", "type": "query", "description": "The ID of the transition." }, { "name": "skipRemoteOnlyCondition", "value": "", "type": "query", "description": "Whether transitions with the condition *Hide From User Condition* are included in the response." }, { "name": "includeUnavailableTransitions", "value": "", "type": "query", "description": "Whether details of transitions that fail a condition are included in the response" }, { "name": "sortByOpsBarAndStatus", "value": "", "type": "query", "description": "Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value." } ] }, "docs": "Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.

This operation can be accessed anonymously.

**[Permissions](#permissions) required: A list or transition is returned only when the user has:**

* *Browse projects* [project per" }, { "info": { "name": "Atlassian Transition Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue/:issueIdOrKey/transitions", "params": [ { "name": "issueIdOrKey", "value": "", "type": "path", "description": "The ID or key of the issue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

sortByCategory To update the fields on the transition screen, specify the fields in the `fields` or `update` parameters in the request body. Get details about the fields using [ Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the `transitions.fields` expand.

This operation can be accessed anonymously.

**[Permissions](#permissions) require" }, { "info": { "name": "Atlassian Export Archived Issue S", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/issues/archive/export", "body": { "type": "json", "data": "{}" } }, "docs": "Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it will receive an email with a link to download a CSV file with the issue details.

Note that this API only exports the values of system fields and archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields aren't supported.

**[Permissions](#permissions) required:** Jira admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Create Issue", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/issue", "params": [ { "name": "updateHistory", "value": "", "type": "query", "description": "Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.

The content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the is" } ] } ], "bundled": true }