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 https //confluence atlassian com/jirakb/finding the id for issue types 646186508 htmllink to project id for issue types https //confluence atlassian com/jirakb/how to get project id from the jira user interface 827341414 htmlconfiguring of atlassian jira oauth 2 0 (server / dc) https //confluence atlassian com/adminjiraserver/jira oauth 2 0 provider api 1115659070 htmlatlassian jira cloud oauth 2 0 (3lo) https //developer atlassian com/cloud/jira/platform/oauth 2 3lo apps/jira service management assets rest api https //developer atlassian com/cloud/assets/rest/assets oauth 2 0 (3lo) scopes https //developer atlassian com/cloud/assets/scopes for oauth 2 3lo and forge apps/ 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 https //docs swimlane com/connectors/atlassian jiraatlassian jira api documentation https //developer atlassian com/cloud/jira/platform/rest/v3/intro/atlassian jira authentication guide https //docs swimlane com/authentication guides/atlassian jira 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/ https //api atlassian com/ex/jira/{cloud id} " 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 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 {"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" \[{"workspaceid" "string","globalid" "string","id" "12345678 1234 1234 1234 123456789abc","objecttypeattribute" {},"objecttypeattributeid" "string","objectattributevalues" \[],"objectid" "string"}],"extendedinfo" { 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" "\<p>this is a test \<br />\<strong>this is a test \<br />\</strong>\<em>this is a test \</em>\<strong>\<br />\</strong>\<span style=\\"color #f1c40f;\\">this is a test \<br />\</span>\</p>\n\<p>\<span style=\\"color #e03e2d;\\">this is a test \</span>\</p>"}} 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 johnson\@example com mailto\ johnson\@example com 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 {"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 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 johnson\@example com mailto\ johnson\@example com 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 {"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 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 {"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"}} 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 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