POST /rest/api/2/search/jql

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.

Servers

https://your-domain.atlassian.net

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`maxResults`	Integer	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 are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only. It returns max 5000 issues. Default value: 50
`fieldsByKeys`	Boolean	No	Reference fields by their key (rather than ID). The default is `false`.
`properties[]`	Array	No	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
`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.
`reconcileIssues[]`	Array	No	Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids
`fields[]`	Array	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 dash to exclude. The default is `id`. Examples: `summary,comment` Returns the summary and comments fields only. `*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.
`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.
`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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.