Get a Jira issue | New Relic Documentation

Retrieves the details of a specific Jira issue using its key.

For authentication setup, see Jira issue actions.

Input Field	Optionality	Type	Description	Example
authToken	Required	String	Base64-encoded string of `email:API_Token` for Basic Authentication. Must be provided as a secret. See Create and manage API tokens.	`"${{ :secrets:jiraAuthToken }}"`
domain	Required	String	Your Jira Cloud instance domain (company name). Used to construct the base URL `your-domain.atlassian.net`.	`"mycompany"`
issueKey	Required	String	The key of the Jira issue to retrieve.	`"PROJ-1234"`
parameters	Optional	Map	Optional URL query parameters for the Jira API request. See the parameters reference table below.	`{"fields": "summary,status", "expand": "transitions"}`
selectors	Optional	List	A list of named expressions to extract specific values from the response.	`[{"name": "summary", "expression": ".responseBody.result.summary"}]`

Parameters reference

Parameter	Type	Description	Default
fields	array<string>	A comma-separated list of fields to return for the issue. Use `all` for all fields, `navigable` for navigable fields, or prefix a field name with `-` to exclude it. Examples: `summary,comment`, `-description`, `*navigable,-comment`.	All fields
fieldsByKeys	Boolean	Whether fields in `fields` are referenced by keys rather than IDs. Useful for connect app fields.	`false`
expand	String	Comma-separated list of additional information to include. Options: `renderedFields`, `names`, `schema`, `transitions`, `editmeta`, `changelog`, `versionedRepresentations`.
properties	array<string>	A comma-separated list of issue properties to return. Use `*all` for all properties, or prefix a property key with `-` to exclude it.
updateHistory	Boolean	Whether to add the issue's project to the user's recently viewed project list in Jira. Also populates the `lastViewed` field in JQL search.	`false`
failFast	Boolean	When `true`, the request fails immediately if any field cannot be loaded. When `false`, the response is returned with empty values for failed fields.	`false`

Output Field	Type	Example
response	Object	`{ "id": "10001", "key": "PROJ-1234", "fields": { "summary": "Test Ticket 1", ... } }`
success	Boolean	`success: true \| false`
errorMessage	String	`{ "errorMessages": ["Issue does not exist or you do not have permission to see it."], "errors": {} }`

Workflow example
`name: get-jira-issue-details description: 'Retrieves the summary and status of a specific Jira issue.' steps: - name: get_issue type: action action: jira.issue.get version: 1 inputs: authToken: ${{ :secrets:jiraAuthToken }} domain: mycompany issueKey: PROJ-567 parameters: fields: "summary,status,issuetype" next: end`

Workflow example

name: get-jira-issue-details
description: 'Retrieves the summary and status of a specific Jira issue.'
steps:
  - name: get_issue
    type: action
    action: jira.issue.get
    version: 1
    inputs:
      authToken: ${{ :secrets:jiraAuthToken }}
      domain: mycompany
      issueKey: PROJ-567
      parameters:
        fields: "summary,status,issuetype"
    next: end