Jira

Jira JQL API

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 query builders. It also provides operations to: * convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. * convert readable details in one or more JQL queries to IDs where a user doesn't have permission to view the entity whose details are readable.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/jql/autocompletedata Get JQL field and function reference data · Get field reference data (GET) #
Ask an LLM
“What fields and functions can I use when writing JQL searches?”
“Is there a downloadable reference of every JQL field and reserved word?”
Tell an agent
Get the full JQL field and function reference data.
Download the JQL autocomplete reference for all fields.
POST /rest/api/3/jql/autocompletedata Get JQL reference data for specific projects · Get field reference data (POST) #
Ask an LLM
“Can I get JQL field reference data limited to certain projects?”
“Is there a way to include collapsed fields in the JQL reference?”
Tell an agent
Get JQL reference data for projects {projectIds}.
Fetch JQL field reference with collapsed fields set to {includeCollapsedFields}.
GET /rest/api/3/jql/autocompletedata/suggestions Suggest JQL values for a field · Get field auto complete suggestions #
Ask an LLM
“What values can I type for a field in a JQL query?”
“Can I get autocomplete suggestions for a partially typed field value?”
Tell an agent
Suggest JQL values for field {fieldName}.
Suggest values for {fieldName} that contain {fieldValue}.
POST /rest/api/3/jql/parse Parse and validate JQL queries · Parse JQL query #
Ask an LLM
“How can I check whether a JQL query is valid before running it?”
“Can I get the parsed structure of a JQL query?”
Tell an agent
Parse and validate JQL {queries} with validation mode {validation}.
Check JQL queries {queries} for errors using {validation} validation.
POST /rest/api/3/jql/pdcleaner Convert usernames in JQL to account IDs · Convert user identifiers to account IDs in JQL queries #
Ask an LLM
“How do I make stored JQL queries GDPR compliant by replacing usernames?”
“Can I convert user keys in saved JQL to account IDs?”
Tell an agent
Convert user identifiers in JQL {queryStrings} to account IDs.
Rewrite queries {queryStrings} so they reference account IDs instead of usernames.
POST /rest/api/3/jql/sanitize Hide details a user can't see in JQL · Sanitize JQL queries #
Ask an LLM
“How do I strip project names a user isn't allowed to see out of a JQL query?”
“Can I sanitize JQL for a specific user's permissions?”
Tell an agent
Sanitize JQL queries {queries}.
Replace restricted names with IDs in queries {queries}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-jql-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-jql-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

jira-jql-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST JQL API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-jql-api-openapi.yml