Atlassian Jira

The Atlassian Jira connector allows seamless integration with Jira's project management and issue tracking capabilities.

Atlassian Jira is a leading project management and issue tracking platform widely used for agile software development. This connector enables seamless integration with Swimlane Turbine, allowing users to automate issue management, streamline workflows, and enhance collaboration. By leveraging Jira's capabilities within Turbine, security teams can efficiently manage tasks, track progress, and ensure timely resolution of issues, all while maintaining a high level of security and compliance.

Prerequisites

Before you can use the Atlassian Jira connector for Turbine, you'll need access to the Jira API. This requires the following:

HTTP Basic authentication using the following parameters:

URL: The base URL of your Jira instance.

Username: Your Jira account username.

API Token: A token generated for API access.

OAuth2 Client Credentials authentication using the following parameters:

Client ID: The client identifier for your application.

Client Secret: The secret key associated with your client ID.

HTTP Bearer authentication using the following parameters:

URL: The base URL of your Jira instance.

Access Token: A token used for bearer authentication.

Custom authentication using the following parameter:

URL: The base URL of your Jira instance.

Capabilities

The Atlassian Jira connector has the following capabilities:

Add Attachment

Add Comment

Assign Issue

Assets - Create Object (CMDB)

Assets - Get Accessible Resources (CMDB)

Assets - Get Object by ID (CMDB)

Assets - Get Object Schema Object Types (CMDB)

Assets - Get Workspace ID (CMDB)

Assets - List Object Schemas (CMDB)

Assets - Search Objects (AQL) (CMDB)

Assets - Update Object (CMDB)

Convert Rich text to ADF

Create Issue

Delete Attachment

Delete Comment ... and so on

Additional Information

In the case of using the Create Issue action, please check the following urls for the IssueType ID, Project Key ID and other related inputs.

Link to sample ID for Issue Types

Link to project ID for Issue Types

Configuring of Atlassian JIRA OAuth 2.0 (Server / DC)

Atlassian Jira Cloud OAuth 2.0 (3LO)

Jira Service Management Assets REST API

Assets OAuth 2.0 (3LO) scopes

The Swimlane team provides a Python script (atlassian_jira_token_generator/) and instructions on how to use it to generate the Access Token, Refresh Token and Cloud ID for either Jira Cloud or Jira Server / Data Center.

The Assets / CMDB actions target Jira Service Management Assets via https://api.atlassian.com/ex/jira/{cloud_id}/jsm/assets/workspace/{workspace_id}/v1/.... They require the OAuth 2.0 - Jira Cloud asset type and the corresponding read:cmdb-* / write:cmdb-* scopes. Use the Assets - Get Accessible Resources action to discover the cloud_id for your refresh token (it hits https://api.atlassian.com/oauth/token/accessible-resources), then Assets - Get Workspace ID to look up the matching workspace_id.

Additional Documentation

Atlassian Jira Connector Documentation

Atlassian Jira API Documentation

Atlassian Jira Authentication Guide

Configurations

Atlassian JIRA Custom Authentication

Atlassian JIRA custom authentication using Access Token or Client Credentials.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
access_token	The Access token.	string	Optional
client_id	The client ID must correspond to the client ID specified in the registered client table.	string	Optional
client_secret	The client secret must correspond to the redirect URI specified in the registered client table.	string	Optional
refresh_token	The Refresh token.	string	Optional
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

HTTP Basic Authentication

Authenticates using username and API token.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
username	Username	string	Required
password	API Token	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

HTTP Bearer Authentication

Authenticates using bearer token.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
token	The ACCESS token	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

OAuth 2.0 - Jira Cloud

Authenticates to Jira Cloud (and the JSM Assets / CMDB API) via OAuth 2.0. Supports refresh_token (user-context 3LO) and client_credentials (app-context, no user consent) grants - the connector picks one based on the fields you supply.

Configuration Parameters

Parameter	Description	Type	Required
url	Base URL used for Jira Cloud REST calls. For OAuth 2.0 this must be the Atlassian gateway, in the form "https://api.atlassian.com/ex/jira/". Leave blank to have it constructed automatically from the Cloud ID.	string	Optional
cloud_id	Atlassian Cloud ID for the target site. Only used when the URL field is blank. Retrieve it from https://api.atlassian.com/oauth/token/accessible-resources.	string	Optional
workspace_id	Optional. Workspace ID for the Jira Service Management Assets (CMDB) API. Required when running any of the "Assets ..." actions.	string	Optional
token_url	OAuth 2.0 token endpoint. Defaults to the Atlassian Cloud endpoint and rarely needs to be overridden.	string	Optional
client_id	Client ID from the Atlassian Developer Console OAuth 2.0 app.	string	Required
client_secret	Client Secret from the Atlassian Developer Console OAuth 2.0 app.	string	Required
refresh_token	Optional. Long-lived refresh token issued after a user consented to the OAuth 2.0 authorization flow (the offline_access scope is required to obtain one). If provided, the connector uses the refresh_token grant for user-context auth. Leave blank to fall back to the client_credentials grant.	string	Optional
access_token	Optional. If provided, this access token is used directly and the refresh-token exchange is skipped. Use only for short tests - access tokens are valid for 1 hour.	string	Optional
scope	Space-separated OAuth 2.0 scopes requested when exchanging the refresh token. Leave blank to inherit the scopes granted at consent time.	string	Optional
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Add Comment

Add a comment to a Jira issue using the unique issueIdOrKey as a path parameter.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/comment

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	Parameters for the Add Comment action
parameters.expand	string	Optional	Use expand to include additional information in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML

Input Example

{"parameters":{"expand":"renderedBody"},"path_parameters":{"issueIdOrKey":"SCT-214"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
self	string	Output field: self
id	string	Unique identifier
author	object	Output field: author
author.self	string	Output field: author.self
author.accountId	string	Unique identifier
author.emailAddress	string	Output field: author.emailAddress
author.avatarUrls	object	URL endpoint for the request
author.avatarUrls.48x48	string	URL endpoint for the request
author.avatarUrls.24x24	string	URL endpoint for the request
author.avatarUrls.16x16	string	URL endpoint for the request
author.avatarUrls.32x32	string	URL endpoint for the request
author.displayName	string	Name of the resource
author.active	boolean	Output field: author.active
author.timeZone	string	Output field: author.timeZone
author.accountType	string	Type of the resource
body	object	Request body data
body.type	string	Request body data
body.version	number	Request body data
body.content	array	Request body data
body.content.type	string	Request body data
body.content.content	array	Request body data
body.content.content.type	string	Request body data
body.content.content.text	string	Request body data

Output Example

{"self":"string","id":"12345678-1234-1234-1234-123456789abc","author":{"self":"string","accountId":"string","emailAddress":"string","avatarUrls":{"48x48":"string","24x24":"string","16x16":"string","32x32":"string"},"displayName":"Example Name","active":true,"timeZone":"string","accountType":"string"},"body":{"type":"string","version":123,"content":[{}]},"updateAuthor":{"self":"string","accountId":"string","emailAddress":"string","avatarUrls":{"48x48":"string","24x24":"string","16x16":"string","3...

Assets - Create Object

Create a new Jira Service Management Assets object by providing the object type ID and attribute values. Requires workspaceId path parameter and write:cmdb-object:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/object/create

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID.
objectTypeId	string	Optional	ID of the object type this object belongs to.
attributes	array	Optional	Parameter for Assets - Create Object
attributes.objectTypeAttributeId	string	Required	Unique identifier
attributes.objectAttributeValues	array	Required	Value for the parameter
attributes.objectAttributeValues.value	string	Optional	Value for the parameter
hasAvatar	boolean	Optional	Parameter for Assets - Create Object
avatarUUID	string	Optional	Unique identifier

Input Example

{"json_body":{"objectTypeId":"23","attributes":[{"objectTypeAttributeId":"135","objectAttributeValues":[{"value":"NY-1"}]},{"objectTypeAttributeId":"144","objectAttributeValues":[{"value":"99"}]}]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
workspaceId	string	Unique identifier
globalId	string	Unique identifier
id	string	Unique identifier
label	string	Output field: label
objectKey	string	Output field: objectKey
name	string	Name of the resource
avatar	object	Output field: avatar
objectType	object	Type of the resource
created	string	Output field: created
updated	string	Output field: updated
hasAvatar	boolean	Output field: hasAvatar
timestamp	integer	Output field: timestamp
_links	object	Output field: _links
_links.self	string	Output field: _links.self

Output Example

{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","label":"string","objectKey":"string","name":"Example Name","avatar":{},"objectType":{},"created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","hasAvatar":true,"timestamp":123,"_links":{"self":"string"}}

Assets - Get Accessible Resources

Return a list of Atlassian sites accessible with the provided OAuth 2.0 token to discover the cloud_id for other Assets actions.

Endpoint

URL: /oauth/token/accessible-resources

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Assets - Get Object by ID

Load a single Jira Service Management Assets (CMDB) object by its internal ID. Requires workspaceId and ID as path parameters and the read:cmdb-object:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/object/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID.
path_parameters.id	string	Required	The Assets object ID to retrieve (numeric internal ID).

Input Example

{"path_parameters":{"workspaceId":"11111111-2222-3333-4444-555555555555","id":"12345"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
workspaceId	string	Unique identifier
globalId	string	Unique identifier
id	string	Unique identifier
label	string	Output field: label
objectKey	string	Output field: objectKey
name	string	Name of the resource
avatar	object	Output field: avatar
avatar.workspaceId	string	Unique identifier
avatar.url16	string	URL endpoint for the request
avatar.url48	string	URL endpoint for the request
avatar.url72	string	URL endpoint for the request
avatar.url144	string	URL endpoint for the request
avatar.url288	string	URL endpoint for the request
avatar.objectId	string	Unique identifier
avatar.mediaClientConfig	object	Output field: avatar.mediaClientConfig
avatar.mediaClientConfig.clientId	string	Unique identifier
avatar.mediaClientConfig.mediaBaseUrl	string	URL endpoint for the request
avatar.mediaClientConfig.mediaJwtToken	string	Output field: avatar.mediaClientConfig.mediaJwtToken
avatar.mediaClientConfig.fileId	string	Unique identifier
objectType	object	Type of the resource
objectType.workspaceId	string	Unique identifier
objectType.globalId	string	Unique identifier
objectType.id	string	Unique identifier

Output Example

{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","label":"string","objectKey":"string","name":"Example Name","avatar":{"workspaceId":"string","url16":"string","url48":"string","url72":"string","url144":"string","url288":"string","objectId":"string","mediaClientConfig":{"clientId":"string","mediaBaseUrl":"string","mediaJwtToken":"string","fileId":"string"}},"objectType":{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","...

Assets - Get Object Schema Object Types

List the object types in a specified Assets (CMDB) object schema in Atlassian Jira. Requires workspaceId and ID as path parameters and the read:cmdb-type:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/objectschema/{{id}}/objecttypes

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID.
path_parameters.id	string	Required	The ID of the object schema whose object types you want to list.
parameters.excludeAbstract	boolean	Optional	Exclude abstract object types from the response.

Input Example

{"path_parameters":{"workspaceId":"string","id":"12345678-1234-1234-1234-123456789abc"},"parameters":{"excludeAbstract":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Assets - Get Workspace ID

Retrieve the Jira Service Management Assets workspace ID for the authenticated Jira Cloud site. Useful for bootstrapping the workspaceId required by all other Assets actions.

Endpoint

URL: /rest/servicedeskapi/assets/workspace

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
size	number	Output field: size
start	number	Output field: start
limit	number	Output field: limit
isLastPage	boolean	Output field: isLastPage
_links	object	Output field: _links
_links.self	string	Output field: _links.self
_links.base	string	Output field: _links.base
_links.context	string	Output field: _links.context
_links.next	string	Output field: _links.next
_links.prev	string	Output field: _links.prev
values	array	Value for the parameter
values.workspaceId	string	Unique identifier

Output Example

{"size":123,"start":123,"limit":123,"isLastPage":true,"_links":{"self":"string","base":"string","context":"string","next":"string","prev":"string"},"values":[{"workspaceId":"string"}]}

Assets - List Object Schemas

List all Jira Service Management Assets object schemas accessible to the authenticated user in a specified workspace. Requires the read:cmdb-schema:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/objectschema/list

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID. Retrieve it from /rest/servicedeskapi/assets/workspace.
parameters.startAt	integer	Optional	Zero-based index of the first object schema to return.
parameters.maxResults	integer	Optional	Maximum number of object schemas to return per page.
parameters.includeCounts	boolean	Optional	Whether to populate objectCount and objectTypeCount for each schema in the response.

Input Example

{"path_parameters":{"workspaceId":"string"},"parameters":{"startAt":123,"maxResults":25,"includeCounts":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	integer	Output field: startAt
maxResults	integer	Result of the operation
total	integer	Output field: total
isLast	boolean	Output field: isLast
last	boolean	Output field: last
values	array	Value for the parameter
values.workspaceId	string	Unique identifier
values.globalId	string	Unique identifier
values.id	string	Unique identifier
values.name	string	Name of the resource
values.objectSchemaKey	string	Value for the parameter
values.status	string	Status value
values.description	string	Value for the parameter
values.created	string	Value for the parameter
values.updated	string	Value for the parameter
values.objectCount	integer	Value for the parameter
values.objectTypeCount	integer	Type of the resource
values.canManage	boolean	Value for the parameter
values.idAsInt	integer	Unique identifier

Output Example

{"startAt":123,"maxResults":123,"total":123,"isLast":true,"last":true,"values":[{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","name":"Example Name","objectSchemaKey":"string","status":"active","description":"string","created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","objectCount":123,"objectTypeCount":123,"canManage":true,"idAsInt":123}]}

Assets - Search Objects (AQL)

Search Jira Service Management Assets using AQL and return paginated matches with attribute metadata. Requires workspaceId and qlQuery inputs, along with read:cmdb-object:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/object/aql

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID.
parameters.startAt	integer	Optional	Zero-based index of the first object to return.
parameters.maxResults	integer	Optional	Maximum number of objects to return per page. Atlassian caps this at 500.
parameters.includeAttributes	boolean	Optional	Whether to include attribute values in the response.
qlQuery	string	Optional	Assets Query Language string, for example: objectType = "Server" AND "Hostname" LIKE "web*"

Input Example

{"json_body":{"qlQuery":"objectType = \"Office\" AND Name LIKE \"SYD\""}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	integer	Output field: startAt
maxResults	integer	Result of the operation
total	integer	Output field: total
isLast	boolean	Output field: isLast
values	array	Value for the parameter
values.workspaceId	string	Unique identifier
values.globalId	string	Unique identifier
values.id	string	Unique identifier
values.label	string	Value for the parameter
values.objectKey	string	Value for the parameter
values.name	string	Name of the resource
values.avatar	object	Value for the parameter
values.objectType	object	Type of the resource
values.created	string	Value for the parameter
values.updated	string	Value for the parameter
values.hasAvatar	boolean	Value for the parameter
values.timestamp	integer	Value for the parameter
values.attributes	array	Attribute values for the object. Pair with the top-level objectTypeAttributes array to resolve the attribute metadata (name, type, cardinality, etc.).
values.attributes.workspaceId	string	Unique identifier
values.attributes.globalId	string	Unique identifier
values.attributes.id	string	Unique identifier
values.attributes.objectTypeAttributeId	string	Unique identifier
values.attributes.objectAttributeValues	array	Value for the parameter

Output Example

{"startAt":123,"maxResults":123,"total":123,"isLast":true,"values":[{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","label":"string","objectKey":"string","name":"Example Name","avatar":{},"objectType":{},"created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","hasAvatar":true,"timestamp":123,"attributes":[],"_links":{}}],"objectTypeAttributes":[{"workspaceId":"string","globalId":"string","id":"12345678-1234-1234-1234-123456789abc","name":"Example...

Assets - Update Object

Update an existing Jira Service Management Assets object by specifying the object type and attribute values. Requires workspaceId, id, objectTypeId, attributes, and write:cmdb-object:jira OAuth 2.0 scope.

Endpoint

URL: /jsm/assets/workspace/{{workspaceId}}/v1/object/{{id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.workspaceId	string	Required	The Jira Service Management Assets workspace ID.
path_parameters.id	string	Required	The Assets object ID to update.
objectTypeId	string	Optional	ID of the object type the object belongs to.
attributes	array	Optional	Array of attribute objects to set / overwrite.
attributes.objectTypeAttributeId	string	Required	Unique identifier
attributes.objectAttributeValues	array	Required	Value for the parameter
attributes.objectAttributeValues.value	string	Optional	Value for the parameter
hasAvatar	boolean	Optional	Parameter for Assets - Update Object
avatarUUID	string	Optional	Unique identifier

Input Example

{"json_body":{"objectTypeId":"23","attributes":[{"objectTypeAttributeId":"265","objectAttributeValues":[{"value":"A placeholder value"}]}],"avatarUUID":"","hasAvatar":false},"path_parameters":{"workspaceId":"11111111-2222-3333-4444-555555555555","id":"12345"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
workspaceId	string	Unique identifier
globalId	string	Unique identifier
id	string	Unique identifier
label	string	Output field: label
objectKey	string	Output field: objectKey
name	string	Name of the resource
avatar	object	Output field: avatar
objectType	object	Type of the resource
created	string	Output field: created
updated	string	Output field: updated
hasAvatar	boolean	Output field: hasAvatar
timestamp	integer	Output field: timestamp
attributes	array	Output field: attributes
attributes.workspaceId	string	Unique identifier
attributes.globalId	string	Unique identifier
attributes.id	string	Unique identifier
attributes.objectTypeAttribute	object	Type of the resource
attributes.objectTypeAttributeId	string	Unique identifier
attributes.objectAttributeValues	array	Value for the parameter
attributes.objectAttributeValues.value	string	Value for the parameter
attributes.objectAttributeValues.displayValue	string	Value for the parameter
attributes.objectAttributeValues.searchValue	string	Value for the parameter
attributes.objectAttributeValues.referencedType	boolean	Type of the resource

Output Example

Assign Issue

Assign a specified Jira issue to a user, ensuring the user has the required project permissions. Requires issue ID or key as a path parameter.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/assignee

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue to assign
accountId	string	Optional	The account ID of the user to assign the issue to. Use -1 to unassign the issue. Max length is 128.
name	string	Optional	The name of the user to assign the issue to
key	string	Optional	The key of the user to assign the issue to

Input Example

{"json_body":{"accountId":"5b10a2844c20165700ede21g"},"path_parameters":{"issueIdOrKey":"PROJ-123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
accountId	string	Unique identifier
displayName	string	Name of the resource
emailAddress	string	Output field: emailAddress
active	boolean	Output field: active
timeZone	string	Output field: timeZone
accountType	string	Type of the resource
avatarUrls	object	URL endpoint for the request
avatarUrls.16x16	string	URL endpoint for the request
avatarUrls.24x24	string	URL endpoint for the request
avatarUrls.32x32	string	URL endpoint for the request
avatarUrls.48x48	string	URL endpoint for the request

Output Example

{"accountId":"string","displayName":"Example Name","emailAddress":"string","active":true,"timeZone":"string","accountType":"string","avatarUrls":{"16x16":"string","24x24":"string","32x32":"string","48x48":"string"}}

Add Attachment

Add an attachment to a Jira issue using the issueIdOrKey, along with necessary path parameters and headers.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/attachments

Method: POST

Input

Argument Name	Type	Required	Description
attachments	array	Required	Attachment to add
attachments.file	string	Optional	Parameter for Add Attachment
attachments.file_name	string	Optional	Name of the resource
path_parameters.issueIdOrKey	string	Required	Parameters for the Add Attachment action
headers	object	Required	HTTP headers for the request
headers.X-Atlassian-Token	string	Required	HTTP headers for the request

Input Example

{"path_parameters":{"issueIdOrKey":"SCT-216"},"headers":{"X-Atlassian-Token":"no-check"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Delete Attachment

Remove a specified attachment from an issue in Atlassian Jira using the unique attachment ID. Requires path parameters and headers.

Endpoint

URL: /rest/api/3/attachment/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Parameters for the Delete Attachment action
headers	object	Required	HTTP headers for the request
headers.X-Atlassian-Token	string	Required	HTTP headers for the request

Input Example

{"path_parameters":{"id":"64327"},"headers":{"X-Atlassian-Token":"no-check"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"response_text":"string"}

Convert Rich text to ADF

Convert rich text to Atlassian Document Format (ADF) for compatibility with Jira applications.

Input

Argument Name	Type	Required	Description
rich_text	object	Optional	Parameter for Convert Rich text to ADF
rich_text.summary	string	Optional	Parameter for Convert Rich text to ADF

Input Example

{"rich_text":{"summary":"This is a test. This is a test. This is a test. This is a test. \nThis is a test."}}

Output

Parameter	Type	Description
summary	object	Output field: summary
summary.version	number	Output field: summary.version
summary.type	string	Type of the resource
summary.content	array	Response content
summary.content.type	string	Type of the resource
summary.content.content	array	Response content
summary.content.content.type	string	Type of the resource
summary.content.content.text	string	Response content
summary.content.content.marks	array	Response content
summary.content.content.marks.type	string	Type of the resource
summary.content.content.marks.attrs	object	Response content
title	object	Output field: title
title.version	number	Output field: title.version
title.type	string	Type of the resource
title.content	array	Response content
title.content.type	string	Type of the resource
title.content.content	array	Response content
title.content.content.type	string	Type of the resource
title.content.content.text	string	Response content
gen	object	Output field: gen
gen.version	number	Output field: gen.version
gen.type	string	Type of the resource
gen.content	array	Response content
gen.content.file_name	string	Name of the resource
gen.content.file	string	Response content

Output Example

{"summary":{"version":1,"type":"doc","content":[{},{}]},"title":{"version":1,"type":"doc","content":[{}]},"gen":{"version":1,"type":"doc","content":[]},"p1":{"version":1,"type":"doc","content":[{},{},{}]},"p2":{"version":1,"type":"doc","content":[{},{},{}]},"p3":{"version":1,"type":"doc","content":[{}]}}

Delete Comment

Remove a specified comment from an issue in Atlassian Jira using the provided issue and comment IDs.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/comment/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue
path_parameters.id	string	Required	The ID of the comment

Input Example

{"path_parameters":{"issueIdOrKey":"PROJ-123","id":10001}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errorMessages	array	Response message
errors	object	Error message if any

Output Example

{"errorMessages":["string"],"errors":{}}

Delete Issue

Delete a specified Jira issue using issueIdOrKey, ensuring any subtasks are deleted first.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue to delete
parameters.deleteSubtasks	string	Optional	Whether the issue's subtasks are deleted when the issue is deleted

Input Example

{"parameters":{"deleteSubtasks":false},"path_parameters":{"issueIdOrKey":"PROJ-123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errorMessages	array	Response message
errors	object	Error message if any

Output Example

{"errorMessages":["string"],"errors":{}}

Find Users

Retrieve up to 50 Atlassian Jira users matching the search term.

Endpoint

URL: /rest/api/3/user/search

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected]. Required, unless username is specified.
parameters.username	string	Optional	This parameter is no longer available and will be removed from the documentation soon. Use query instead.
parameters.accountId	string	Optional	A query string that is matched exactly against user account ID. Required, unless query is specified.
parameters.property	string	Optional	A query string used to search properties. Property keys are specified by path, so properties which are not direct properties of the returned objects should not be matched. For example, if value is returned by a property called something.nested.property, then the request should include something.nested as the property. If the property is an array, then the request should include something.nested[] as the property.
parameters.maxResults	number	Optional	The maximum number of items to return per page
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)

Input Example

{"parameters":{"query":"john","maxResults":50,"startAt":0}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Find Users Assignable to Issues

Retrieve a list of users eligible for issue assignment in Atlassian Jira, aiding in efficient task delegation.

Endpoint

URL: /rest/api/3/user/assignable/search

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.sessionId	string	Optional	The ID of the session.
parameters.accountId	string	Optional	A query string that is matched exactly against user account ID. Required, unless query is specified.
parameters.project	string	Optional	The key of the project.
parameters.issueKey	string	Optional	The key of the issue.
parameters.issueId	string	Optional	The ID of the issue.
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page
parameters.actionDescriptorId	number	Optional	The ID of the action descriptor.
parameters.recommend	boolean	Optional	Whether to recommend users.

Input Example

{"parameters":{"query":"john","sessionId":"example-session-id-123","username":"deprecated-user-name","accountId":"5b10a2844c20165700ede21g","project":"EX","issueKey":"EX-1","issueId":"10001","startAt":0,"maxResults":50,"actionDescriptorId":21,"recommend":false}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
accountId	string	Unique identifier
accountType	string	Type of the resource
active	boolean	Output field: active
applicationRoles	object	Output field: applicationRoles
applicationRoles.items	array	Output field: applicationRoles.items
applicationRoles.items.file_name	string	Name of the resource
applicationRoles.items.file	string	Output field: applicationRoles.items.file
applicationRoles.size	number	Output field: applicationRoles.size
avatarUrls	object	URL endpoint for the request
avatarUrls.16x16	string	URL endpoint for the request
avatarUrls.24x24	string	URL endpoint for the request
avatarUrls.32x32	string	URL endpoint for the request
avatarUrls.48x48	string	URL endpoint for the request
displayName	string	Name of the resource
emailAddress	string	Output field: emailAddress
groups	object	Output field: groups
groups.items	array	Output field: groups.items
groups.items.file_name	string	Name of the resource
groups.items.file	string	Output field: groups.items.file
groups.size	number	Output field: groups.size
key	string	Output field: key
name	string	Name of the resource
self	string	Output field: self

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":true,"applicationRoles":{"items":[],"size":1},"avatarUrls":{"16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/init...","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/init...","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/init...","48x48":"https:/...

Find Users Assignable to Projects

Retrieve a list of users eligible for issue assignment in specified Atlassian Jira projects, with optional attribute matching. Requires projectKeys as input.

Endpoint

URL: /rest/api/3/user/assignable/multiProjectSearch

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.projectKeys	string	Required	A list of project keys (case sensitive). This parameter accepts a comma-separated list.
parameters.accountId	string	Optional	A query string that is matched exactly against user account ID. Required, unless query is specified.
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"query":"john","projectKeys":"EX,TEST","startAt":0,"maxResults":50}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":[{"accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","active":false,"avatarUrls":{},"displayName":"Mia Krystof","key":"","name":"","self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ed..."},{"accountId":"5b10ac8d82e05b22cc7d4ef5","accountType":"atlassian","active":false,"avatarUrls":{},"displayName":"Emma Richards","key":"","name":"","self":"https://your-domain.atlassian.net/rest/a...

Find Users for Picker

Retrieve a list of Atlassian Jira users matching the query term, with matches highlighted using HTML strong tags. Requires 'query' parameter.

Endpoint

URL: /rest/api/3/user/picker

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Required	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.maxResults	number	Optional	The maximum number of items to return. The total number of matched users is returned in total.
parameters.showAvatar	boolean	Optional	Whether to include the avatar URL in the response.
parameters.excludeAccountIds	array	Optional	A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list.
parameters.avatarSize	string	Optional	The size of the avatar to return.
parameters.excludeConnectUsers	boolean	Optional	Whether to exclude users from Connect apps from the search results.

Input Example

{"parameters":{"query":"john","maxResults":50,"showAvatar":true,"excludeAccountIds":["5b10a2844c20165700ede21g","5b10a0effa615349cb016cd8","5b10ac8d82e05b22cc7d4ef5"],"avatarSize":"xlarge","excludeConnectUsers":false}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
header	string	Output field: header
total	number	Output field: total
users	array	Output field: users
users.accountId	string	Unique identifier
users.accountType	string	Type of the resource
users.avatarUrl	string	URL endpoint for the request
users.displayName	string	Name of the resource
users.html	string	Output field: users.html
users.key	string	Output field: users.key
users.name	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"header":"Showing 20 of 25 matching groups","total":25,"users":[{}]}}

Find Users Keys by Query

Retrieve a paginated list of user keys from Atlassian Jira based on a structured query input. Requires the query parameter.

Endpoint

URL: /rest/api/3/user/search/query/key

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Required	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"query":"search text","startAt":0,"maxResults":100}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
isLast	boolean	Output field: isLast
maxResults	number	Result of the operation
nextPage	string	Output field: nextPage
self	string	Output field: self
startAt	number	Output field: startAt
total	number	Output field: total
values	array	Value for the parameter
values.accountId	string	Unique identifier
values.key	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"isLast":true,"maxResults":51,"nextPage":"<string>","self":"<string>","startAt":37,"total":29,"values":[{}]}}

Find Users by Query

Retrieve up to 50 Atlassian Jira users matching a specified search query using the 'query' parameter.

Endpoint

URL: /rest/api/3/user/search/query

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Required	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.maxResults	number	Optional	The maximum number of items to return per page
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)

Input Example

{"parameters":{"query":"john","maxResults":50,"startAt":0}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
self	string	Output field: self
maxResults	number	Result of the operation
startAt	number	Output field: startAt
total	number	Output field: total
isLast	boolean	Output field: isLast
nextPage	string	Output field: nextPage
values	array	Value for the parameter
values.accountId	string	Unique identifier
values.accountType	string	Type of the resource
values.active	boolean	Value for the parameter
values.applicationRoles	object	Value for the parameter
values.applicationRoles.callback	object	Value for the parameter
values.applicationRoles.items	array	Value for the parameter
values.applicationRoles.max-results	number	Value for the parameter
values.applicationRoles.pagingCallback	object	Value for the parameter
values.applicationRoles.size	number	Value for the parameter
values.avatarUrls	object	URL endpoint for the request
values.avatarUrls.16x16	string	URL endpoint for the request
values.avatarUrls.24x24	string	URL endpoint for the request
values.avatarUrls.32x32	string	URL endpoint for the request
values.avatarUrls.48x48	string	URL endpoint for the request
values.displayName	string	Name of the resource
values.emailAddress	string	Value for the parameter

Output Example

{"self":"string","maxResults":123,"startAt":123,"total":123,"isLast":true,"nextPage":"string","values":[{"accountId":"string","accountType":"string","active":true,"applicationRoles":{},"avatarUrls":{},"displayName":"Example Name","emailAddress":"string","expand":"string","groups":{},"key":"string","locale":"string","name":"Example Name","self":"string","timeZone":"string"}]}

Find Users with Browse Permission

Retrieve a list of users matching a search string who have permission to browse issues in Atlassian Jira. Requires query parameter.

Endpoint

URL: /rest/api/3/user/viewissue/search

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Required	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.accountId	string	Optional	A query string that is matched exactly against user account ID. Required, unless query is specified.
parameters.issueKey	string	Optional	The key of the issue.
parameters.projectKey	string	Optional	The key of the project.
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"query":"john","username":"deprecated-user-name","accountId":"5b10a2844c20165700ede21g","issueKey":"EX-1","projectKey":"EX","startAt":0,"maxResults":50}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

Find Users with Permissions

Retrieve a list of Atlassian Jira users matching a search string and possessing specified permissions for projects or issues. Requires permission parameters.

Endpoint

URL: /rest/api/3/user/permission/search

Method: GET

Input

Argument Name	Type	Required	Description
parameters.query	string	Optional	A query string that is matched against user attributes (displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of [email protected].
parameters.accountId	string	Optional	A query string that is matched exactly against user account ID. Required, unless query is specified.
parameters.permissions	string	Required	A comma-separated list of permissions.
parameters.issueKey	string	Optional	The key of the issue.
parameters.projectKey	string	Optional	The key of the project.
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"query":"john","username":"deprecated-user-name","accountId":"5b10a2844c20165700ede21g","permissions":"BROWSE,EDIT_ISSUE","issueKey":"EX-1","projectKey":"EX","startAt":0,"maxResults":50}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

Get All Users Default

Retrieve a comprehensive list of all users, including active, inactive, and deleted accounts in Atlassian Jira.

Endpoint

URL: /rest/api/3/users

Method: GET

Input

Argument Name	Type	Required	Description
parameters.startAt	number	Optional	The index of the first item to return.
parameters.maxResults	number	Optional	The maximum number of items to return.

Input Example

{"parameters":{"startAt":0,"maxResults":50}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Thu, 09 Jan 2025 10:07:44 GMT","Content-Type":"application/json;charset=UTF-8","Server":"AtlassianEdge","Timing-Allow-Origin":"*","X-Arequestid":"45c9fb52879c4b3eb540cd8c9fb94205","Set-Cookie":"atlassian.xsrf.token=5b8d9da0169a025c9f394f0e4434c12aa4e646d5_lin; Path=/; SameS...","X-Aaccountid":"5d07f57ceec00a0bcb5eca63","Cache-Control":"no-cache, no-store, no-transform","Vary":"Accept-Encoding","Content-Encoding":"gzip","X-Content-Type-Options":"nosn...

Get Attachment Content

Download a Jira attachment using its ID and return it as a standard Turbine file attachment reference.

Endpoint

URL: /rest/api/3/attachment/content/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	The ID of the attachment
parameters.redirect	boolean	Optional	Whether Jira should redirect to the attachment URL. Leave false so the connector can return a Turbine file attachment.

Input Example

{"path_parameters":{"id":10001}}

Output

Parameter	Type	Description
status_code	number	HTTP status code returned by Jira.
reason	string	HTTP reason phrase returned by Jira.
file	array	The downloaded Jira attachment as a standard Turbine file attachment reference.
file.file_name	string	Original filename of the Jira attachment.
file.file	string	Turbine file reference ID. Use this value in downstream playbook steps that accept file attachments.

Output Example

{"status_code":200,"reason":"OK","response_headers":{"Content-Type":"image/jpeg","Content-Disposition":"attachment; filename=\"picture.jpg\""},"file":[{"file_name":"picture.jpg","file":"abc123-turbine-file-reference-id"}]}

Get Attachment Metadata

Retrieve metadata for a specified attachment in Atlassian Jira using the provided attachment ID.

Endpoint

URL: /rest/api/3/attachment/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	The ID of the attachment

Input Example

{"path_parameters":{"id":10001}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
self	string	Output field: self
filename	string	Name of the resource
author	object	Output field: author
author.self	string	Output field: author.self
author.accountId	string	Unique identifier
author.accountType	string	Type of the resource
author.active	boolean	Output field: author.active
author.avatarUrls	object	URL endpoint for the request
author.avatarUrls.16x16	string	URL endpoint for the request
author.avatarUrls.24x24	string	URL endpoint for the request
author.avatarUrls.32x32	string	URL endpoint for the request
author.avatarUrls.48x48	string	URL endpoint for the request
author.displayName	string	Name of the resource
author.key	string	Output field: author.key
author.name	string	Name of the resource
created	string	Output field: created
size	number	Output field: size
mimeType	string	Type of the resource
content	string	Response content
thumbnail	string	Output field: thumbnail

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","self":"string","filename":"Example Name","author":{"self":"string","accountId":"string","accountType":"string","active":true,"avatarUrls":{"16x16":"string","24x24":"string","32x32":"string","48x48":"string"},"displayName":"Example Name","key":"string","name":"Example Name"},"created":"2024-01-01T00:00:00Z","size":123,"mimeType":"string","content":"string","thumbnail":"string"}

Get Jira Attachment Settings

Retrieve attachment configurations in Atlassian Jira, including enablement status and size limits.

Endpoint

URL: /rest/api/3/attachment/meta

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
enabled	boolean	Output field: enabled
uploadLimit	number	Output field: uploadLimit

Output Example

{"enabled":true,"uploadLimit":123}

Get Changelogs

Retrieve a sorted, paginated list of changelogs for a given issue in Atlassian Jira using the issueIdOrKey.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/changelog

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"startAt":0,"maxResults":50},"path_parameters":{"issueIdOrKey":"PROJ-123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	number	Output field: startAt
maxResults	number	Result of the operation
total	number	Output field: total
isLast	boolean	Output field: isLast
nextPage	string	Output field: nextPage
self	string	Output field: self
values	array	Value for the parameter
values.id	string	Unique identifier
values.author	object	Value for the parameter
values.author.self	string	Value for the parameter
values.author.accountId	string	Unique identifier
values.author.active	boolean	Value for the parameter
values.author.avatarUrls	object	URL endpoint for the request
values.author.avatarUrls.16x16	string	URL endpoint for the request
values.author.avatarUrls.24x24	string	URL endpoint for the request
values.author.avatarUrls.32x32	string	URL endpoint for the request
values.author.avatarUrls.48x48	string	URL endpoint for the request
values.author.displayName	string	Name of the resource
values.author.emailAddress	string	Value for the parameter
values.author.timeZone	string	Value for the parameter
values.created	string	Value for the parameter
values.items	array	Value for the parameter
values.items.field	string	Value for the parameter

Output Example

{"startAt":123,"maxResults":123,"total":123,"isLast":true,"nextPage":"string","self":"string","values":[{"id":"12345678-1234-1234-1234-123456789abc","author":{},"created":"2024-01-01T00:00:00Z","items":[]}]}

Get Comment

Retrieve a specific comment from an issue in Atlassian Jira using the provided issue ID or key and comment ID.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/comment/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue
path_parameters.id	string	Required	The ID of the comment
parameters.expand	string	Optional	Use expand to include additional information in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML

Input Example

{"parameters":{"expand":"renderedBody"},"path_parameters":{"issueIdOrKey":"PROJ-123","id":10001}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
self	string	Output field: self
id	string	Unique identifier
author	object	Output field: author
author.self	string	Output field: author.self
author.accountId	string	Unique identifier
author.active	boolean	Output field: author.active
author.displayName	string	Name of the resource
body	object	Request body data
body.type	string	Request body data
body.version	number	Request body data
body.content	array	Request body data
body.content.type	string	Request body data
body.content.content	array	Request body data
body.content.content.type	string	Request body data
body.content.content.text	string	Request body data
created	string	Output field: created
updated	string	Output field: updated
updateAuthor	object	Output field: updateAuthor
updateAuthor.self	string	Output field: updateAuthor.self
updateAuthor.accountId	string	Unique identifier
updateAuthor.active	boolean	Output field: updateAuthor.active
updateAuthor.displayName	string	Name of the resource
visibility	object	Output field: visibility

Output Example

{"self":"string","id":"12345678-1234-1234-1234-123456789abc","author":{"self":"string","accountId":"string","active":true,"displayName":"Example Name"},"body":{"type":"string","version":123,"content":[{}]},"created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","updateAuthor":{"self":"string","accountId":"string","active":true,"displayName":"Example Name"},"visibility":{"identifier":"string","type":"string","value":"string"}}

Get Comments

Retrieve all comments from a specified Jira issue using the issueIdOrKey, with optional ordering by creation date.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/comment

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page
parameters.orderBy	string	Optional	Order the results by a particular field
parameters.expand	string	Optional	Use expand to include additional information in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML

Input Example

{"parameters":{"startAt":0,"maxResults":50,"orderBy":"created","expand":"renderedBody"},"path_parameters":{"issueIdOrKey":"PROJ-123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	number	Output field: startAt
maxResults	number	Result of the operation
total	number	Output field: total
comments	array	Output field: comments
comments.self	string	Output field: comments.self
comments.id	string	Unique identifier
comments.author	object	Output field: comments.author
comments.author.self	string	Output field: comments.author.self
comments.author.accountId	string	Unique identifier
comments.author.emailAddress	string	Output field: comments.author.emailAddress
comments.author.avatarUrls	object	URL endpoint for the request
comments.author.avatarUrls.16x16	string	URL endpoint for the request
comments.author.avatarUrls.24x24	string	URL endpoint for the request
comments.author.avatarUrls.32x32	string	URL endpoint for the request
comments.author.avatarUrls.48x48	string	URL endpoint for the request
comments.author.displayName	string	Name of the resource
comments.author.active	boolean	Output field: comments.author.active
comments.author.timeZone	string	Output field: comments.author.timeZone
comments.author.accountType	string	Type of the resource
comments.body	object	Request body data
comments.body.type	string	Request body data
comments.body.version	number	Request body data
comments.body.content	array	Request body data

Output Example

{"startAt":123,"maxResults":123,"total":123,"comments":[{"self":"string","id":"12345678-1234-1234-1234-123456789abc","author":{},"body":{},"updateAuthor":{},"created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","jsdPublic":true}]}

Get Comments by IDs

Fetch a paginated list of comments from Atlassian Jira using specified comment IDs, with optional anonymous access. Requires 'ids' in the JSON body.

Endpoint

URL: /rest/api/3/comment/list

Method: POST

Input

Argument Name	Type	Required	Description
parameters.expand	string	Optional	Use expand to include additional information in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML
ids	array	Optional	The list of comment IDs

Input Example

{"parameters":{"expand":"renderedBody"},"json_body":{"ids":[10001,10002,10003]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	number	Output field: startAt
maxResults	number	Result of the operation
total	number	Output field: total
isLast	boolean	Output field: isLast
values	array	Value for the parameter
values.self	string	Value for the parameter
values.id	string	Unique identifier
values.author	object	Value for the parameter
values.author.self	string	Value for the parameter
values.author.accountId	string	Unique identifier
values.author.active	boolean	Value for the parameter
values.author.displayName	string	Name of the resource
values.body	object	Request body data
values.body.type	string	Request body data
values.body.version	number	Request body data
values.body.content	array	Request body data
values.body.content.type	string	Request body data
values.body.content.content	array	Request body data
values.body.content.content.type	string	Request body data
values.body.content.content.text	string	Request body data
values.created	string	Value for the parameter
values.updated	string	Value for the parameter
values.updateAuthor	object	Value for the parameter

Output Example

{"startAt":123,"maxResults":123,"total":123,"isLast":true,"values":[{"self":"string","id":"12345678-1234-1234-1234-123456789abc","author":{},"body":{},"created":"2024-01-01T00:00:00Z","updated":"2024-01-01T00:00:00Z","updateAuthor":{},"visibility":{}}]}

Get Fields

Retrieve all system and custom issue fields available in Atlassian Jira, providing a comprehensive field list.

Endpoint

URL: /rest/api/3/field

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Get All Labels

Obtain a paginated list of labels from Atlassian Jira to categorize issues effectively.

Endpoint

URL: /rest/api/3/label

Method: GET

Input

Argument Name	Type	Required	Description
parameters.startAt	number	Optional	The index of the first item to return in a page of results (page offset)
parameters.maxResults	number	Optional	The maximum number of items to return per page

Input Example

{"parameters":{"startAt":0,"maxResults":50}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
startAt	number	Output field: startAt
maxResults	number	Result of the operation
total	number	Output field: total
isLast	boolean	Output field: isLast
values	array	Value for the parameter

Output Example

{"startAt":123,"maxResults":123,"total":123,"isLast":true,"values":["string"]}

Get Project

Retrieve detailed information for a specified project in Atlassian Jira using the projectIdOrKey.

Endpoint

URL: /rest/api/3/project/{{projectIdOrKey}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.projectIdOrKey	string	Required	The project ID or project key (case sensitive)
parameters.expand	string	Optional	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include description, issueTypes, lead, projectKeys, url, permissions

Input Example

{"parameters":{"expand":"description,lead,url","properties":"key,value"},"path_parameters":{"projectIdOrKey":"PROJ"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
expand	string	Output field: expand
self	string	Output field: self
id	string	Unique identifier
key	string	Output field: key
description	string	Output field: description
lead	object	Output field: lead
lead.self	string	Output field: lead.self
lead.accountId	string	Unique identifier
lead.accountType	string	Type of the resource
lead.active	boolean	Output field: lead.active
lead.avatarUrls	object	URL endpoint for the request
lead.avatarUrls.16x16	string	URL endpoint for the request
lead.avatarUrls.24x24	string	URL endpoint for the request
lead.avatarUrls.32x32	string	URL endpoint for the request
lead.avatarUrls.48x48	string	URL endpoint for the request
lead.displayName	string	Name of the resource
lead.key	string	Output field: lead.key
lead.name	string	Name of the resource
components	array	Output field: components
components.ari	string	Output field: components.ari
components.assignee	object	Output field: components.assignee
components.assignee.self	string	Output field: components.assignee.self
components.assignee.accountId	string	Unique identifier

Output Example

{"expand":"string","self":"string","id":"12345678-1234-1234-1234-123456789abc","key":"string","description":"string","lead":{"self":"string","accountId":"string","accountType":"string","active":true,"avatarUrls":{"16x16":"string","24x24":"string","32x32":"string","48x48":"string"},"displayName":"Example Name","key":"string","name":"Example Name"},"components":[{"ari":"string","assignee":{},"assigneeType":"string","description":"string","id":"12345678-1234-1234-1234-123456789abc","isAssigneeTypeV...

Get Available Transitions

Retrieve all possible transitions for a specific Jira issue based on user permissions and current status, using the issueIdOrKey.

Endpoint

URL: /rest/api/3/issue/transitions

Method: GET

Input

Argument Name	Type	Required	Description
parameters.issueIdOrKey	string	Required	The ID or key of the issue
parameters.endingBefore	string	Optional	(Optional) The end cursor for use in pagination.
parameters.startingAfter	string	Optional	(Optional) The start cursor for use in pagination.

Input Example

{"parameters":{"issueIdOrKey":"PROJ-123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
availableTransitions	array	Output field: availableTransitions
availableTransitions.isTransitionsFiltered	boolean	Output field: availableTransitions.isTransitionsFiltered
availableTransitions.issues	array	Output field: availableTransitions.issues
availableTransitions.transitions	array	Output field: availableTransitions.transitions
availableTransitions.transitions.to	object	Output field: availableTransitions.transitions.to
availableTransitions.transitions.to.statusId	number	Unique identifier
availableTransitions.transitions.to.statusName	string	Name of the resource
availableTransitions.transitions.transitionId	number	Unique identifier
availableTransitions.transitions.transitionName	string	Name of the resource

Output Example

{"availableTransitions":[{"isTransitionsFiltered":true,"issues":[],"transitions":[]}]}

Get User

Retrieve a user's details from Atlassian Jira using the provided accountId, while respecting privacy settings.

Endpoint

URL: /rest/api/3/user

Method: GET

Input

Argument Name	Type	Required	Description
parameters.accountId	string	Required	The account ID of the user, which uniquely identifies the user across all Atlassian products. Max length is 128.
parameters.expand	string	Optional	Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: groups includes all groups and nested groups to which the user belongs. applicationRoles includes details of all the applications to which the user has access.

Input Example

{"parameters":{"accountId":"5b10ac8d82e05b22cc7d4ef5","expand":"groups"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
self	string	Output field: self
accountId	string	Unique identifier
accountType	string	Type of the resource
emailAddress	string	Output field: emailAddress
avatarUrls	object	URL endpoint for the request
avatarUrls.48x48	string	URL endpoint for the request
avatarUrls.24x24	string	URL endpoint for the request
avatarUrls.16x16	string	URL endpoint for the request
avatarUrls.32x32	string	URL endpoint for the request
displayName	string	Name of the resource
active	boolean	Output field: active
timeZone	string	Output field: timeZone
locale	string	Output field: locale
groups	object	Output field: groups
groups.size	number	Output field: groups.size
groups.items	array	Output field: groups.items
groups.items.file_name	string	Name of the resource
groups.items.file	string	Output field: groups.items.file
applicationRoles	object	Output field: applicationRoles
applicationRoles.size	number	Output field: applicationRoles.size
applicationRoles.items	array	Output field: applicationRoles.items
applicationRoles.items.file_name	string	Name of the resource
applicationRoles.items.file	string	Output field: applicationRoles.items.file

Output Example

{"status_code":200,"response_headers":{"Date":"Thu, 09 Jan 2025 09:22:15 GMT","Content-Type":"application/json;charset=UTF-8","Server":"AtlassianEdge","Timing-Allow-Origin":"*","X-Arequestid":"3755c266a371a3de6f4ac4e217c9c2cf","Set-Cookie":"atlassian.xsrf.token=180eb947a40a03f89fc1aa377d3d0be76190e334_lin; Path=/; SameS...","X-Aaccountid":"5d07f57ceec00a0bcb5eca63","Cache-Control":"no-cache, no-store, no-transform","Vary":"Accept-Encoding","Content-Encoding":"gzip","X-Content-Type-Options":"nosn...

Create Issue

Create a new issue or subtask in Atlassian Jira using specified fields provided in the JSON body input.

Endpoint

URL: /rest/api/3/issue

Method: POST

Input

Argument Name	Type	Required	Description
fields	object	Optional	Parameter for Create Issue
fields.summary	string	Required	Parameter for Create Issue
fields.parent	object	Optional	Parameter for Create Issue
fields.parent.key	string	Optional	Parameter for Create Issue
fields.issuetype	object	Required	Type of the resource
fields.issuetype.id	string	Required	Unique identifier
fields.components	array	Optional	Parameter for Create Issue
fields.components.id	string	Optional	Unique identifier
fields.project	object	Required	Parameter for Create Issue
fields.project.id	string	Optional	Unique identifier
fields.project.key	string	Optional	Parameter for Create Issue
fields.description	object	Optional	Parameter for Create Issue
fields.description.type	string	Optional	Type of the resource
fields.description.version	number	Optional	Parameter for Create Issue
fields.description.content	array	Optional	Response content
fields.description.content.type	string	Optional	Type of the resource
fields.description.content.content	array	Optional	Response content
fields.description.content.content.text	string	Optional	Response content
fields.description.content.content.type	string	Optional	Type of the resource
fields.reporter	object	Optional	Parameter for Create Issue
fields.reporter.id	string	Optional	Unique identifier
fields.fixVersions	array	Optional	Parameter for Create Issue
fields.fixVersions.id	string	Optional	Unique identifier
fields.priority	object	Optional	Parameter for Create Issue
fields.priority.id	string	Optional	Unique identifier

Input Example

{"json_body":{"fields":{"summary":"Issue summary","parent":{"key":"SCT-214"},"issuetype":{"id":"10000"},"components":[{"id":"10000"}],"project":{"id":"11435"},"description":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"Order entry fails when selecting supplier.","type":"text"}]}]},"reporter":{"id":"5b10a2844c20165700ede21g"},"fixVersions":[{"id":"10001"}],"priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"remainingEstimate":"5","originalEstimate":"10"},"security":{"id":"10000"},"environment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"UAT","type":"text"}]}]},"versions":[{"id":"10000"}],"duedate":"2019-05-11","assignee":{"id":"5b109f2e9729b51b54dc274d"}}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
key	string	Output field: key
self	string	Output field: self

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","key":"string","self":"string"}

Edit Issue

Modify an existing issue in Atlassian Jira using the provided issue ID or key and update details.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	Parameters for the Edit Issue action
historyMetadata	object	Optional	Response data
historyMetadata.actor	object	Optional	Response data
historyMetadata.actor.avatarUrl	string	Optional	Response data
historyMetadata.actor.displayName	string	Optional	Response data
historyMetadata.actor.id	string	Optional	Response data
historyMetadata.actor.type	string	Optional	Response data
historyMetadata.actor.url	string	Optional	Response data
historyMetadata.extraData	object	Optional	Response data
historyMetadata.extraData.Iteration	string	Optional	Response data
historyMetadata.extraData.Step	string	Optional	Response data
historyMetadata.description	string	Optional	Response data
historyMetadata.generator	object	Optional	Response data
historyMetadata.generator.id	string	Optional	Response data
historyMetadata.generator.type	string	Optional	Response data
historyMetadata.cause	object	Optional	Response data
historyMetadata.cause.id	string	Optional	Response data
historyMetadata.cause.type	string	Optional	Response data
historyMetadata.activityDescription	string	Optional	Response data
historyMetadata.type	string	Optional	Response data
update	object	Optional	Date value
update.summary	array	Optional	Parameter for Edit Issue
update.summary.set	string	Optional	Parameter for Edit Issue
update.components	array	Optional	Parameter for Edit Issue
update.components.set	string	Optional	Parameter for Edit Issue

Input Example

{"json_body":{"historyMetadata":{"actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"extraData":{"Iteration":"10a","Step":"4"},"description":"From the order testing process","generator":{"id":"mysystem-1","type":"mysystem-application"},"cause":{"id":"myevent","type":"mysystem-event"},"activityDescription":"Complete order processing","type":"myplugin:type"},"update":{"summary":[{"set":"Bug in business logic"}],"components":[{"set":""}],"timetracking":[{"edit":{"remainingEstimate":"4d","originalEstimate":"1w 1d"}}],"labels":[{"add":"triaged"},{"remove":"blocker"}]},"fields":{"summary":"Completed orders still displaying in pending","customfield_10010":1,"customfield_10000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"Investigation underway","type":"text"}]}]}},"properties":[{"value":"Order number 10784","key":"key1"},{"value":"Order number 10923","key":"key2"}]},"path_parameters":{"issueIdOrKey":"SCT-216"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"response_text":"string"}

Get Issue

Retrieve detailed information for a specific issue in Atlassian Jira using the provided issue ID or key.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	Parameters for the Get Issue action

Input Example

{"path_parameters":{"issueIdOrKey":"SC-5427"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
expand	string	Output field: expand
id	string	Unique identifier
self	string	Output field: self
key	string	Output field: key
fields	object	Output field: fields
fields.parent	object	Output field: fields.parent
fields.parent.id	string	Unique identifier
fields.parent.key	string	Output field: fields.parent.key
fields.parent.self	string	Output field: fields.parent.self
fields.parent.fields	object	Output field: fields.parent.fields
fields.parent.fields.summary	string	Output field: fields.parent.fields.summary
fields.parent.fields.status	object	Status value
fields.parent.fields.status.self	string	Status value
fields.parent.fields.status.description	string	Status value
fields.parent.fields.status.iconUrl	string	URL endpoint for the request
fields.parent.fields.status.name	string	Name of the resource
fields.parent.fields.status.id	string	Unique identifier
fields.parent.fields.status.statusCategory	object	Status value
fields.parent.fields.priority	object	Output field: fields.parent.fields.priority
fields.parent.fields.priority.self	string	Output field: fields.parent.fields.priority.self
fields.parent.fields.priority.iconUrl	string	URL endpoint for the request
fields.parent.fields.priority.name	string	Name of the resource
fields.parent.fields.priority.id	string	Unique identifier

Output Example

{"expand":"string","id":"12345678-1234-1234-1234-123456789abc","self":"string","key":"string","fields":{"parent":{"id":"12345678-1234-1234-1234-123456789abc","key":"string","self":"string","fields":{}},"resolution":{},"lastViewed":{},"labels":[{}],"aggregatetimeoriginalestimate":{},"issuelinks":[{}],"assignee":{"self":"string","accountId":"string","emailAddress":"string","avatarUrls":{},"displayName":"Example Name","active":true,"timeZone":"string","accountType":"string"},"subtasks":[{}],"report...

Search

Execute a JQL-based search for issues in Atlassian Jira using specified criteria and return matching results.

Endpoint

URL: /rest/api/3/search/jql

Method: POST

Input

Argument Name	Type	Required	Description
expand	string	Optional	To include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a comma-delimited string of values.
fields	array	Optional	A list of fields to return for each issue. Use it to retrieve a subset of fields. This parameter accepts a comma-separated list.
fieldsByKeys	boolean	Optional	Reference fields by their key (rather than ID).
jql	string	Optional	For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.
maxResults	number	Optional	The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only. It returns max 5000 issues.
nextPageToken	string	Optional	The token for a page to fetch that is not the first page. The first page has a nextPageToken of null. Use the nextPageToken to fetch the next page of issues.
properties	array	Optional	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
reconcileIssues	array	Optional	Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids.

Input Example

{"json_body":{"expand":"names","fields":["id"],"fieldsByKeys":true,"jql":"assignee = currentUser() order by key","maxResults":273,"nextPageToken":"testing","properties":["property 1"],"reconcileIssues":[2154]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
isLast	boolean	Output field: isLast
issues	array	Output field: issues
issues.expand	string	Output field: issues.expand
issues.fields	object	Output field: issues.fields
issues.fields.watcher	object	Output field: issues.fields.watcher
issues.fields.watcher.isWatching	boolean	Output field: issues.fields.watcher.isWatching
issues.fields.watcher.self	string	Output field: issues.fields.watcher.self
issues.fields.watcher.watchCount	number	Count value
issues.fields.attachment	array	Output field: issues.fields.attachment
issues.fields.attachment.author	object	Output field: issues.fields.attachment.author
issues.fields.attachment.author.accountId	string	Unique identifier
issues.fields.attachment.author.accountType	string	Type of the resource
issues.fields.attachment.author.active	boolean	Output field: issues.fields.attachment.author.active
issues.fields.attachment.author.avatarUrls	object	URL endpoint for the request
issues.fields.attachment.author.displayName	string	Name of the resource
issues.fields.attachment.author.key	string	Output field: issues.fields.attachment.author.key
issues.fields.attachment.author.name	string	Name of the resource
issues.fields.attachment.author.self	string	Output field: issues.fields.attachment.author.self
issues.fields.attachment.content	string	Response content
issues.fields.attachment.created	string	Output field: issues.fields.attachment.created
issues.fields.attachment.filename	string	Name of the resource
issues.fields.attachment.id	number	Unique identifier
issues.fields.attachment.mimeType	string	Type of the resource

Output Example

{"isLast":true,"issues":[{"expand":"string","fields":{},"id":"12345678-1234-1234-1234-123456789abc","key":"string","self":"string"}]}

Transition Issue

Perform a transition for a specified Jira issue using the issueIdOrKey, and update fields if the transition has an associated screen.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/transitions

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue to transition.
fields	object	Optional	The fields to update on the issue.
fields.assignee	object	Optional	The user to assign the issue to.
fields.assignee.name	string	Optional	The name of the user to assign the issue to.
fields.resolution	object	Optional	The resolution of the issue.
fields.resolution.name	string	Optional	Name of the resource
historyMetadata	object	Optional	The metadata for the history of the issue.
historyMetadata.activityDescription	string	Optional	The description of the activity.
historyMetadata.actor	object	Optional	The actor of the activity.
historyMetadata.actor.avatarUrl	string	Optional	The URL of the avatar of the actor.
historyMetadata.actor.displayName	string	Optional	The display name of the actor.
historyMetadata.actor.id	string	Optional	The ID of the actor.
historyMetadata.actor.type	string	Optional	The type of the actor.
historyMetadata.actor.url	string	Optional	The URL of the actor.
historyMetadata.cause	object	Optional	The cause of the activity.
historyMetadata.cause.id	string	Optional	The ID of the cause.
historyMetadata.cause.type	string	Optional	Response data
historyMetadata.description	string	Optional	Response data
historyMetadata.extraData	object	Optional	The extra data of the activity.
historyMetadata.extraData.Iteration	string	Optional	The iteration of the activity.
historyMetadata.extraData.Step	string	Optional	The step of the activity.
historyMetadata.generator	object	Optional	The generator of the activity.
historyMetadata.generator.id	string	Optional	The ID of the generator.
historyMetadata.generator.type	string	Optional	Response data
historyMetadata.type	string	Optional	The type of the activity.

Input Example

{"json_body":{"fields":{"assignee":{"name":"bob"},"resolution":{"name":"Fixed"}},"historyMetadata":{"activityDescription":"Complete order processing","actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"cause":{"id":"myevent","type":"mysystem-event"},"description":"From the order testing process","extraData":{"Iteration":"10a","Step":"4"},"generator":{"id":"mysystem-1","type":"mysystem-application"},"type":"myplugin:type"},"transition":{"id":"5"},"update":{"comment":[{"add":{"body":{"content":[{"content":[{"text":"Bug has been fixed","type":"text"}],"type":"paragraph"}],"type":"doc","version":1}}}]}},"path_parameters":{"issueIdOrKey":"SCRUM-1"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"status_code":204,"response_headers":{},"reason":"NO Content","response_text":""}

Add Comment

Add or update a comment on an Atlassian Jira issue using the issue ID or key and comment ID.

Endpoint

URL: /rest/api/3/issue/{{issueIdOrKey}}/comment/{{id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.issueIdOrKey	string	Required	The ID or key of the issue
path_parameters.id	string	Required	The ID of the comment
parameters.notifyUsers	boolean	Optional	Whether users are notified when a comment is updated
parameters.overrideEditableFlag	boolean	Optional	Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
parameters.expand	string	Optional	Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
visibility	object	Optional	The group or role to which this comment is visible. Optional on create and update.
visibility.identifier	string	Optional	The ID of the group or the name of the role that visibility of this item is restricted to.
visibility.type	string	Optional	Whether visibility of this item is restricted to a group or role.
visibility.value	string	Optional	The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use identifier.
body	object	Optional	The comment text in Atlassian Document Format.
body.type	string	Optional	Request body data
body.version	number	Optional	Request body data
body.content	array	Required	Request body data
body.content.type	string	Optional	Request body data
body.content.content	array	Optional	Request body data
body.content.content.type	string	Optional	Request body data
body.content.content.text	string	Optional	Request body data
properties	array	Optional	A list of comment properties. Optional on create and update.
properties.key	string	Optional	The key of the property. Required on create and update.
properties.value	string	Optional	The value of the property. Required on create and update.

Input Example

{"parameters":{"notifyUsers":true,"overrideEditableFlag":false,"expand":"renderedBody"},"json_body":{"visibility":{"identifier":"Administrators","type":"role","value":"Administrators"},"body":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"Updated comment content"}]}]},"properties":[{"key":"comment.property.key","value":"property value"}]},"path_parameters":{"issueIdOrKey":"PROJ-123","id":10001}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
self	string	Output field: self
id	string	Unique identifier
author	object	Output field: author
author.self	string	Output field: author.self
author.accountId	string	Unique identifier
author.active	boolean	Output field: author.active
author.displayName	string	Name of the resource
body	object	Request body data
body.type	string	Request body data
body.version	number	Request body data
body.content	array	Request body data
body.content.type	string	Request body data
body.content.content	array	Request body data
body.content.content.type	string	Request body data
body.content.content.text	string	Request body data
created	string	Output field: created
updated	string	Output field: updated
updateAuthor	object	Output field: updateAuthor
updateAuthor.self	string	Output field: updateAuthor.self
updateAuthor.accountId	string	Unique identifier
updateAuthor.active	boolean	Output field: updateAuthor.active
updateAuthor.displayName	string	Name of the resource
visibility	object	Output field: visibility

Output Example

Response Headers

Header	Description	Example
Atl-Request-Id	HTTP response header: Atl-Request-Id	d99ae7c1-56c8-4ec3-be94-36847ece934f
Atl-Traceid	HTTP response header: Atl-Traceid	c73756dd55fa4fafad7cd6518aacfb80
Beta-Retry-After	HTTP response header: Beta-Retry-After	1
Cache-Control	Directives for caching mechanisms	no-cache, no-store, no-transform
Connection	HTTP response header: Connection	keep-alive
Content-Encoding	HTTP response header: Content-Encoding	gzip
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT
Expect-Ct	HTTP response header: Expect-Ct
Location	The URL to redirect a page to
Nel	HTTP response header: Nel	{"failure_fraction": 0.001, "include_subdomains": true, "max_age": 600, "report_to": "endpoint-1"}
Report-To	HTTP response header: Report-To	{"endpoints": [{"url": "https://dz8aopenkvv6s.cloudfront.net"}], "group": "endpoint-1", "include_subdomains": true, "max_age": 600}
Server	Information about the software used by the origin server	AtlassianEdge
Server-Timing	HTTP response header: Server-Timing	atl-edge;dur=340,atl-edge-internal;dur=14,atl-edge-upstream;dur=328,atl-edge-pop;desc="aws-ap-south-1"
Set-Cookie	HTTP response header: Set-Cookie	atlassian.xsrf.token=180eb947a40a03f89fc1aa377d3d0be76190e334_lin; Path=/; SameSite=None; Secure
Strict-Transport-Security	HTTP response header: Strict-Transport-Security	max-age=63072000; includeSubDomains; preload
Timing-Allow-Origin	HTTP response header: Timing-Allow-Origin	*
Transfer-Encoding	HTTP response header: Transfer-Encoding	chunked
Vary	HTTP response header: Vary	Accept-Encoding
Via	HTTP response header: Via	1.1 0298f468fb8a5be020d6f3e7ff839738.cloudfront.net (CloudFront)
X-Aaccountid	HTTP response header: X-Aaccountid	5d07f57ceec00a0bcb5eca63
X-Amz-Cf-Id	HTTP response header: X-Amz-Cf-Id	ZKlYd-_Pa7Of_c1e8ksPSSzlZxEFILYkb0HWus4DCqCAS_v5wrPXzA==
X-Amz-Cf-Pop	HTTP response header: X-Amz-Cf-Pop	BOM78-P1
X-Arequestid	HTTP response header: X-Arequestid	9cee465f51193f09c0fceae8f2c2a1d6
X-Beta-Ratelimit-Limit	HTTP response header: X-Beta-Ratelimit-Limit	200
X-Beta-Ratelimit-Reason	HTTP response header: X-Beta-Ratelimit-Reason	jira-burst-based
X-Beta-Ratelimit-Remaining	HTTP response header: X-Beta-Ratelimit-Remaining	199
X-Beta-Ratelimit-Reset	HTTP response header: X-Beta-Ratelimit-Reset	2025-09-08T10:41Z
X-Cache	HTTP response header: X-Cache	Miss from cloudfront
X-Content-Type-Options	HTTP response header: X-Content-Type-Options	nosniff
X-Xss-Protection	HTTP response header: X-Xss-Protection	1; mode=block