search

count-issues

Count issues using JQL

Provide an estimated count of the issues that match the JQL. Recent updates might not be immediately visible in the returned output. This endpoint requires JQL to be bounded.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

POST /rest/api/3/search/approximate-count

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr search count-issues

search-and-reconsile-issues-using-jql

Search for issues using JQL enhanced search (GET)

Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results. If you need read-after-write consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

GET /rest/api/3/search/jql

Flag	Type	Required	Description
--expand	string	No	Use expand 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. The expand options are:

• 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.

Examples: "names,changelog" Returns the display name of each field as well as a list of recent updates to an issue. | | --failFast | string | No | Fail this request early if we can't retrieve all field data. | | --fields | string | No | 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.
• id Returns only issue IDs.
• Any issue field, prefixed with a minus to exclude.

The default is id.

Examples:

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

Multiple fields parameters can be included in a request.

Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields. | | --fieldsByKeys | string | No | Reference fields by their key (rather than ID). The default is false. | | --jql | string | No | A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is 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.

Additionally, orderBy clause can contain a maximum of 7 fields. | | --maxResults | string | No | 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 or properties 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 | No | 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.

Note: The nextPageToken field is not included in the response for the last page, indicating there is no next page. | | --properties | string | No | A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. | | --reconcileIssues | string | No | Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages. |

Example:

jr search search-and-reconsile-issues-using-jql

search-and-reconsile-issues-using-jql-post

Search for issues using JQL enhanced search (POST)

Searches for issues using JQL. Recent updates might not be immediately visible in the returned search results. If you need read-after-write consistency, you can utilize the reconcileIssues parameter to ensure stronger consistency assurances. This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

POST /rest/api/3/search/jql

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr search search-and-reconsile-issues-using-jql-post

search-for-issues-using-jql

Currently being removed. Search for issues using JQL (GET)

Endpoint is currently being removed. More details

Searches for issues using JQL.

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

GET /rest/api/3/search

Flag	Type	Required	Description
--expand	string	No	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. | | --failFast | string | No | 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). | | --fields | string | No | 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. | | --fieldsByKeys | string | No | Reference fields by their key (rather than ID). | | --jql | string | No | 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. | | --maxResults | string | No | 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. | | --properties | string | No | 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. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). | | --validateQuery | string | No | 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. |

Example:

jr search search-for-issues-using-jql

search-for-issues-using-jql-post

Currently being removed. Search for issues using JQL (POST)

Endpoint is currently being removed. More details

Searches for issues using JQL.

There is a GET version of this resource that can be used for smaller JQL query expressions.

This operation can be accessed anonymously.

Permissions required: Issues are included in the response where the user has:

• Browse projects project permission for the project containing the issue.
• If issue-level security is configured, issue-level security permission to view the issue.

POST /rest/api/3/search

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr search search-for-issues-using-jql-post