Atlassian: Search for issues using JQL enhanced search (GET)

← Issue search operations · Get started

Operation atlassian.searchandreconsileissuesusingjql

Provider route: GET /{cloudId}/rest/api/3/search/jql. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueSearch"]["searchAndReconsileIssuesUsingJql"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueSearch.searchAndReconsileIssuesUsingJql(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_search.search_and_reconsile_issues_using_jql(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
query	object	Optional	Additional keys: not allowed
query.jql	string	Optional
query.nextPageToken	string	Optional
query.maxResults	integer	Optional	Default: 50 Format: int32
query.fields	array	Optional
query.fields[]	string	Each item	Default: id
query.expand	string	Optional
query.properties	array	Optional
query.properties[]	string	Each item
query.fieldsByKeys	boolean	Optional	Default: false
query.failFast	boolean	Optional	Default: false
query.reconcileIssues	array	Optional
query.reconcileIssues[]	integer	Each item	Format: int64
query.includeArchivedProjects	boolean	Optional	Default: false

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search for issues using JQL enhanced search (GET) — response body

Referenced models: Search for issues using JQL enhanced search (GET) — response body

Schemas

21 more schemas are linked from the tables above, on the schema pages.

Search for issues using JQL enhanced search (GET) — response body

Field	Type	Presence	Description and constraints
$	object	Root	The result of a JQL search with issues reconsilation.
isLast	JSON	Optional
isLast (anyOf 1)	boolean	Alternative	Indicates whether this is the last page of the paginated response. Read only: true
isLast (anyOf 2)	null	Alternative
issues	JSON	Optional
issues (anyOf 1)	array	Alternative	The list of issues found by the search or reconsiliation. Read only: true
issues (anyOf 1)[]	Model	Each item	Expand Get issue — response body
issues (anyOf 2)	null	Alternative
names	JSON	Optional
names (anyOf 1)	object	Alternative	The ID and name of each field in the search results. Read only: true Additional keys: see wildcard field
names (anyOf 1).*	string	Additional keys	Read only: true
names (anyOf 2)	null	Alternative
nextPageToken	JSON	Optional
nextPageToken (anyOf 1)	string	Alternative	Continuation token to fetch the next page. If this result represents the last or the only page this token will be null. This token will expire in 7 days. Read only: true
nextPageToken (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	object	Alternative	The schema describing the field types in the search results. Read only: true Additional keys: see wildcard field
schema (anyOf 1).*	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
schema (anyOf 2)	null	Alternative
warnings	JSON	Optional
warnings (anyOf 1)	array	Alternative	Experimental. Warnings generated during the search, e.g. when a JQL clause exceeded its argument limit or when the result set was truncated due to an ingestion limit. This field is currently rolling out behind a feature flag and may be absent, empty, or change shape without notice until generally available. Read only: true
warnings (anyOf 1)[]	Model	Each item	Expand Search for issues using JQL enhanced search (GET) — response body — warnings array item
warnings (anyOf 2)	null	Alternative

Referenced models: Get issue — response body, Create custom field — response body — schema The schema of a field, Search for issues using JQL enhanced search (GET) — response body — warnings array item

Get issue — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about an issue.
changelog	JSON	Optional
changelog (anyOf 1)	Model	Alternative	Expand Get changelogs by I Ds — response body Details of changelogs associated with the issue. Read only: true
changelog (anyOf 2)	null	Alternative
editmeta	JSON	Optional
editmeta (anyOf 1)	Model	Alternative	Expand Get edit issue metadata — response body The metadata for the fields on the issue that can be amended. Read only: true
editmeta (anyOf 2)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional issue details in the response. Read only: true
expand (anyOf 2)	null	Alternative
fields	JSON	Optional
fields (anyOf 1)	object	Alternative	Additional keys: see wildcard field
fields (anyOf 1).*	JSON	Additional keys
fields (anyOf 2)	null	Alternative
fieldsToInclude	JSON	Optional
fieldsToInclude (anyOf 1)	Model	Alternative	Expand Get issue — response body — fields To Include actually Included, excluded, included
fieldsToInclude (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue. Read only: true
id (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the issue. Read only: true
key (anyOf 2)	null	Alternative
names	JSON	Optional
names (anyOf 1)	object	Alternative	The ID and name of each field present on the issue. Read only: true Additional keys: see wildcard field
names (anyOf 1).*	string	Additional keys	Read only: true
names (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	Model	Alternative	Expand Get issue — response body — operations link Groups The operations that can be performed on the issue. Read only: true
operations (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	Details of the issue properties identified in the request. Read only: true Additional keys: see wildcard field
properties (anyOf 1).*	JSON	Additional keys	Read only: true
properties (anyOf 2)	null	Alternative
renderedFields	JSON	Optional
renderedFields (anyOf 1)	object	Alternative	The rendered value of each field present on the issue. Read only: true Additional keys: see wildcard field
renderedFields (anyOf 1).*	JSON	Additional keys	Read only: true
renderedFields (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	object	Alternative	The schema describing each field present on the issue. Read only: true Additional keys: see wildcard field
schema (anyOf 1).*	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
schema (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the issue details. Format: uri Read only: true
self (anyOf 2)	null	Alternative
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	The transitions that can be performed on the issue. Read only: true
transitions (anyOf 1)[]	Model	Each item	Expand Get transitions — response body — transitions List of issue transitions item
transitions (anyOf 2)	null	Alternative
versionedRepresentations	JSON	Optional
versionedRepresentations (anyOf 1)	object	Alternative	The versions of each field on the issue. Read only: true Additional keys: see wildcard field
versionedRepresentations (anyOf 1).*	object	Additional keys	Read only: true Additional keys: see wildcard field
versionedRepresentations (anyOf 1).*.*	JSON	Additional keys	Read only: true
versionedRepresentations (anyOf 2)	null	Alternative

Referenced models: Get issue — response body — fields To Include actually Included, excluded, included, Get transitions — response body — transitions List of issue transitions item, Get edit issue metadata — response body, Create custom field — response body — schema The schema of a field, Get issue — response body — operations link Groups, Get changelogs by I Ds — response body

Search for issues using JQL enhanced search (GET) — response body — warnings array item

Field	Type	Presence	Description and constraints
$	object	Root	Experimental. A warning returned alongside successful search results.
details	JSON	Optional
details (anyOf 1)	Model	Alternative	Expand Search for issues using JQL enhanced search (GET) — response body — warnings array item details actual, arguments, clause, limit Structured details about the warning, if available.
details (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative	A human-readable explanation of the warning suitable for surfacing to end users. Read only: true
message (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of warning, e.g. CLAUSE\_LIMIT\_EXCEEDED. Read only: true
type (anyOf 2)	null	Alternative

Referenced models: Search for issues using JQL enhanced search (GET) — response body — warnings array item details actual, arguments, clause, limit

Policy, approvals and errors

SDK function policy ID: atlassian.searchandreconsileissuesusingjql. Catalog operation: searchandreconsileissuesusingjql. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source