Search Jira issues | New Relic Documentation

Searches for Jira issues using a Jira Query Language (JQL) string.

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"`
jql	Required	String	A JQL expression. Requires a bounded query (a query with a search restriction). Example of an unbounded query: `order by key desc`. Example of a bounded query: `assignee = currentUser() order by key`. The `orderBy` clause can contain a maximum of 7 fields.	`"project = PROJ AND status != Done"`
maxResults	Optional	Integer	The maximum number of items to return per page. Returns a maximum of 5000 issues.	`50`
parameters	Optional	Map	Optional additional query parameters for the Jira API request. See the parameters reference table below.	`{"startAt": 0, "fields": "key,summary,status"}`
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
expand	String	Comma-separated list of additional information to include in the response. Options: `renderedFields`, `names`, `schema`, `transitions`, `operations`, `editmeta`, `changelog`, `versionedRepresentations`. Example: `"names,changelog"`.
fields	array<string>	A comma-separated list of fields to return for each issue. Use `all` for all fields, `navigable` for navigable fields, or `id` for issue IDs only. Prefix a field name with `-` to exclude it. Examples: `summary,comment`, `-description`, `*all,-comment`. Default is `id`.
fieldsByKeys	Boolean	Whether to reference fields by their key rather than ID. Default: `false`.
nextPageToken	String	Token for fetching the next page of results. The first page has a `nextPageToken` of `null`. Not included in the last page response.
properties	array<string>	A comma-separated list of up to 5 issue properties to include in the results.
failFast	Boolean	Whether to fail the request quickly if field data cannot be retrieved. Default: `false`.

Output Field	Type	Example
response	Object	`{ "startAt": 0, "maxResults": 50, "total": 1, "issues": [...] }`
success	Boolean	`success: true \| false`
errorMessage	String	`{ "errorMessages": ["The value 'In Progresss' does not exist for the field 'status'."], "errors": {} }`

Workflow example
`name: search_jira_tickets description: 'Finds the 10 most recent open tickets for PROJ, returning summary and status.' steps: - name: search_jira_tickets_1 type: action action: jira.issue.search version: 1 inputs: authToken: ${{ :secrets:jiraAuthToken }} domain: newrelic jql: "project = PROJ AND status != Done" maxResults: 10 parameters: fields: "key,summary,status" startAt: 0 next: end`

Workflow example

name: search_jira_tickets
description: 'Finds the 10 most recent open tickets for PROJ, returning summary and status.'
steps:
  - name: search_jira_tickets_1
    type: action
    action: jira.issue.search
    version: 1
    inputs:
      authToken: ${{ :secrets:jiraAuthToken }}
      domain: newrelic
      jql: "project = PROJ AND status != Done"
      maxResults: 10
      parameters:
        fields: "key,summary,status"
        startAt: 0
    next: end