Search for Issues Using JQL

Options

Set JQL

Enable to set the optional field JQL

JQL

The JQL that defines the search. Note:

• If no JQL expression is provided, all issues are returned.
• username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead.
• If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.

Set Start At

Enable to set the optional field Start At

Start At

The index of the first item to return in a page of results (page offset).

Set Max Results

Enable to set the optional field Max Results

Max Results

The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting id or key only.

Set Validate Query

Enable to set the optional field Validate Query

Validate Query

Determines how to validate the JQL query and treat the validation results. Supported values are:

• strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
• warn Returns all errors as warnings.
• none No validation is performed.
• true Deprecated A legacy synonym for strict.
• false Deprecated A legacy synonym for warn.

Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

Set Fields

Enable to set the optional field Fields

Fields

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

• *all Returns all fields.
• *navigable Returns navigable fields.
• Any issue field, prefixed with a minus to exclude.

Examples:

• summary,comment Returns only the summary and comments fields.
• -description Returns all navigable (default) fields except description.
• *all,-comment Returns all fields except comments.

This parameter may be specified multiple times. For example, fields=field1,field2&fields=field3.

Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

Set Expand

Enable to set the optional field Expand

Expand

Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:

• renderedFields Returns field values rendered in HTML format.
• names Returns the display name of each field.
• schema Returns the schema describing a field type.
• transitions Returns all possible transitions for the issue.
• operations Returns all possible operations for the issue.
• editmeta Returns information about how each field can be edited.
• changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
• versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

Set Properties

Enable to set the optional field Properties

Properties

A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.

Set Fields by Keys

Enable to set the optional field Fields by Keys

Fields by Keys

Reference fields by their key (rather than ID).

Set Fail Fast

Enable to set the optional field Fail Fast

Fail Fast

Whether to fail the request quickly in case of an error while loading fields for an issue. For failFast=true, if one field fails, the entire operation fails. For failFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s).

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Changelog: Details of changelogs associated with the issue.
• Editmeta: The metadata for the fields on the issue that can be amended.
• Expand: Expand options that include additional issue details in the response.
• Fields:
• Fields to Include:
• Id: The ID of the issue.
• Key: The key of the issue.
• Names: The ID and name of each field present on the issue.
• Operations: The operations that can be performed on the issue.
• Properties: Details of the issue properties identified in the request.
• Rendered Fields: The rendered value of each field present on the issue.
• Schema: The schema describing each field present on the issue.
• Self: The URL of the issue details.
• Transitions: The transitions that can be performed on the issue.
• Versioned Representations: The versions of each field on the issue.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• Jira issueby danielesser on 2025-09-08

  forum.knime.com/p/292407

Developers