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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Atlassian

Atlassian JQL API

The JQL API from Atlassian — 5 operation(s) for jql.

Documentation Provider Profile APIs.io OpenAPI GitHub

Atlassian JQL API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include JQL. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

6 operations 5 paths 34 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
Contact
ecosystem@atlassian.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Atlassian JQL API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 6

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

JQL 6

This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom…

GET
/rest/api/3/jql/autocompletedata
Atlassian Get Field Reference Data Get
atlassianGetautocomplete → 200401
POST
/rest/api/3/jql/autocompletedata
Atlassian Get Field Reference Data Post
atlassianGetautocompletepost body → 200400401
GET
/rest/api/3/jql/autocompletedata/suggestions
Atlassian Get Field Auto Complete Suggestions
atlassianGetfieldautocompleteforquerystring 4 params → 200400401
POST
/rest/api/3/jql/parse
Atlassian Parse Jql Query
atlassianParsejqlqueries 1 param body → 200400401
POST
/rest/api/3/jql/pdcleaner
Atlassian Convert User Identifiers To Account Ids In Jql Queries
atlassianMigratequeries body → 200400401
POST
/rest/api/3/jql/sanitize
Atlassian Sanitize Jql Queries
atlassianSanitisejqlqueries body → 200400401403

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are FieldReferenceData (10 properties), FunctionReferenceData (5 properties), SanitizedJqlQuery (4 properties), FieldWasClause (4 properties). Each schema is shown below with its type and property counts.

JQLPersonalDataMigrationRequest
object
The JQL queries to be converted.
1 property
JqlQuery
object
A parsed JQL query.
2 properties
ParsedJqlQuery
object
Details of a parsed JQL query.
3 properties 1 required
JqlQueriesToParse
object
A list of JQL queries to parse.
1 property 1 required
JqlQueryOrderByClause
object
Details of the order-by JQL clause.
1 property 1 required
SanitizedJqlQuery
object
Details of the sanitized JQL query.
4 properties
AutoCompleteSuggestion
object
A field auto-complete suggestion.
2 properties
ErrorCollection
object
Error messages from an operation.
3 properties
AutoCompleteSuggestions
object
The results from a JQL query.
1 property
JQLQueryWithUnknownUsers
object
JQL queries that contained users that could not be found
2 properties
SanitizedJqlQueries
object
The sanitized JQL queries for the given account IDs.
1 property
ValueOperand
object
An operand that is a user-provided value.
2 properties 1 required
FunctionReferenceData
object
Details of functions that can be used in advanced searches.
5 properties
JqlQueryField
object
A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL qu…
3 properties 1 required
ParsedJqlQueries
object
A list of parsed JQL queries.
1 property 1 required
SearchAutoCompleteFilter
object
Details of how to filter and list search auto complete information.
2 properties
JqlQueryClause
object
A JQL query clause.
KeywordOperand
object
An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-refe…
1 property 1 required
FieldReferenceData
object
Details of a field that can be used in advanced searches.
10 properties
ConvertedJQLQueries
object
The converted JQL queries.
2 properties
JqlQueryFieldEntityProperty
object
Details of an entity property.
4 properties 3 required
FunctionOperand
object
An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functio…
3 properties 2 required
JqlQueryUnitaryOperand
object
An operand that can be part of a list operand.
JqlQueryClauseTimePredicate
object
A time predicate for a temporal JQL clause.
2 properties 2 required
FieldWasClause
object
A clause that asserts a previous value of a field. For example, status WAS "Resolved" BY currentUser() BEFORE "2019/02/02". See [WAS](https://confluence.atlass…
4 properties 4 required
JqlQueryOrderByClauseElement
object
An element of the order-by JQL clause.
2 properties 1 required
ListOperand
object
An operand that is a list of values.
2 properties 1 required
FieldChangedClause
object
A clause that asserts whether a field was changed. For example, status CHANGED AFTER startOfMonth(-1M).See [CHANGED](https://confluence.atlassian.com/x/dgiiLQA…
3 properties 3 required
JQLReferenceData
object
Lists of JQL reference data.
3 properties
JqlQueriesToSanitize
object
The list of JQL queries to sanitize for the given account IDs.
1 property 1 required
JqlQueryClauseOperand
object
Details of an operand in a JQL clause.
JqlQueryToSanitize
object
The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user.
2 properties 1 required
FieldValueClause
object
A clause that asserts the current value of a field. For example, summary ~ test.
3 properties 3 required
CompoundClause
object
A JQL query clause that consists of nested clauses. For example, (labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is…
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-jql-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
AE Profile APIs.io
Atlassian Jira Software Board API
AE Profile APIs.io
Atlassian Jira Software Epic API
AE Profile APIs.io
Atlassian Jira Software Sprint API
AE Profile APIs.io
Atlassian Jira Software Development Information API
AE Profile APIs.io
Atlassian Jira Software Feature Flags API
AE Profile APIs.io
Atlassian Jira Software Deployments API
AE Profile APIs.io
Atlassian Jira Software Builds API
AE Profile APIs.io
Atlassian Jira Software Remote Links API
AE Profile APIs.io
Atlassian Jira Software Security Information API
AE Profile APIs.io
Atlassian Jira Service Management Customer API
AE Profile APIs.io
Atlassian Jira Service Management Info API
AE Profile APIs.io
#JQL
← Back to A APIs
API Details
ID
atlassian:atlassian-jql-api
Server
https://your-domain.atlassian.net
Docs
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/#api-group-addon
Provider
Atlassian
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=atlassian-jql-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/atlassian-jql-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Atlassian JQL 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.