How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Issue Search API

Search for issues using JQL (Jira Query Language).

Jira Issue Search API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Issue Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, rate-limit docs, and a changelog.

This API exposes 9 operations across 6 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{domain}.atlassian.net/rest/api/3, https://your-domain.atlassian.net.

9 operations 6 paths 67 schemas 4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://your-domain.atlassian.net/rest/api/3
Authentication
HTTP Basic, OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Jira Issue Search API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes.

  • basicAuth — Basic authentication using an Atlassian account email and API token. Format: email:apitoken, Base64 encoded. Generate API tokens at https://id.atlassian.com/ma…
  • oauth2 — OAuth 2.0 authorization code grant (3LO) for Jira Cloud apps.
  • bearerAuth — Bearer token authentication using a personal access token (PAT) or OAuth 2.0 access token.
  • OAuth2 — OAuth2 scopes for Jira

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Issue Search 9

Search for issues using JQL (Jira Query Language).

GET
/search
Jira Search for Issues Using Jql (get)
searchForIssuesUsingJql 8 params → 200400401
POST
/search
Jira Search for Issues Using Jql (post)
searchForIssuesUsingJqlPost body → 200400401
GET
/rest/api/3/issue/picker
Get issue picker suggestions
getIssuePickerResource 6 params → 200401
POST
/rest/api/3/jql/match
Check issues against JQL
matchIssues body → 200400
GET
/rest/api/3/searchdeprecated
Currently being removed. Search for issues using JQL (GET)
getRestApi3Search 9 params → 200400401
POST
/rest/api/3/searchdeprecated
Currently being removed. Search for issues using JQL (POST)
postRestApi3Search body → 200400401
POST
/rest/api/3/search/approximate-count
Count issues using JQL
countIssues body → 200400401
GET
/rest/api/3/search/jql
Search for issues using JQL enhanced search (GET)
searchAndReconsileIssuesUsingJql 10 params → 200400401
POST
/rest/api/3/search/jql
Search for issues using JQL enhanced search (POST)
searchAndReconsileIssuesUsingJqlPost body → 200400401

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are IssueFields (27 properties), IssueBean_2 (15 properties), IssueTransition (11 properties), HistoryMetadata (11 properties). Each schema is shown below with its type and property counts.

Version
object
A project version.
10 properties
Component
object
A project component.
9 properties
SearchResults
object
The result of a JQL search.
8 properties
SearchRequest
object
Request body for JQL search via POST.
8 properties
IssueTypeDetails
object
Details of an issue type.
9 properties
ProjectRef
object
A reference to a Jira project.
6 properties
ErrorCollection
object
Error details returned by the API.
3 properties
IssueLinkType
object
The type of link between issues.
5 properties
ChangeHistory
object
A changelog entry.
4 properties
Votes
object
The votes for an issue.
3 properties
StatusCategory
object
A status category in Jira.
5 properties
ChangeItem
object
An individual field change within a changelog entry.
7 properties
IssueLink
object
A link between issues.
5 properties
StatusDetails
object
A status in Jira.
6 properties
Watches
object
The watchers of an issue.
3 properties
IssueFields
object
The fields of a Jira issue.
27 properties
AtlassianDocumentFormat
object
Atlassian Document Format (ADF) representation of rich text content. ADF is a JSON-based format used in Jira Cloud REST API v3 for description, comment, and ot…
3 properties 3 required
Attachment
object
An attachment on an issue.
9 properties
Changelog
object
A paginated list of changelogs.
4 properties
PageOfWorklogs
object
A paginated list of worklogs.
4 properties
Visibility
object
The visibility restrictions for a comment.
3 properties
Transition
object
A workflow transition.
8 properties
IssueRef
object
A reference to an issue.
4 properties
Worklog
object
A worklog entry.
10 properties
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties
UserDetails
object
A Jira user.
8 properties
Priority
object
An issue priority.
6 properties
Resolution
object
An issue resolution.
4 properties
PageOfComments
object
A paginated list of comments.
4 properties
IssueBean
object
A Jira issue with all fields and metadata.
10 properties
Scope
object
The scope of the issue type (project or global).
2 properties
Comment
object
A comment on an issue.
10 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
SearchRequestBean
object
8 properties
FieldMetadata
object
The metadata describing an issue field.
10 properties 5 required
SearchResults_2
object
The result of a JQL search.
8 properties
SearchWarningLimitDetails
object
Experimental. Structured details about a JQL clause exceeding its argument limit.
4 properties
Operations
object
Details of the operations that can be performed on the issue.
1 property
IssueTransition
object
Details of an issue transition.
11 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
ChangeDetails
object
A change item.
7 properties
StatusCategory_2
object
A status category.
5 properties
StatusDetails_2
object
A status.
7 properties
IssuePickerSuggestions
object
A list of issues suggested for use in auto-completion.
1 property
IssuePickerSuggestionsIssueType
object
A type of issue suggested for use in auto-completion.
5 properties
IssueUpdateMetadata
object
A list of editable field details.
1 property
JQLCountResultsBean
object
1 property
SearchAndReconcileRequestBean
object
9 properties
SuggestedIssue
object
An issue suggested for use in the issue picker auto-completion.
6 properties
Changelog_2
object
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.
5 properties
IssuesAndJQLQueries
object
List of issues and JQL queries.
2 properties 2 required
SearchWarning
object
Experimental. A warning returned alongside successful search results.
3 properties
AvatarUrlsBean
object
4 properties
LinkGroup
object
Details a link group, which defines issue operations.
6 properties
IncludedFields
object
3 properties
SearchAndReconcileResults
object
The result of a JQL search with issues reconsilation.
6 properties
IssueMatchesForJQL
object
A list of the issues matched to a JQL query or details of errors encountered during matching.
2 properties 2 required
HistoryMetadata
object
Details of issue history metadata.
11 properties
UpdatedProjectCategory
object
A project category.
4 properties
IssueMatches
object
A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.
1 property 1 required
UserDetails_2
object
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: This occurs…
10 properties
JQLCountRequestBean
object
1 property
ProjectDetails
object
Details about a project.
8 properties
IssueBean_2
object
Details about an issue.
15 properties
Scope_2
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
PageOfChangelogs
object
A page of changelogs.
4 properties
HistoryMetadataParticipant
object
Details of user or system associated with a issue history metadata item.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-search-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Atlassian Remote MCP Server
Where this information came from

This is an independent, third-party profile of Jira Issue Search API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.