Atlassian: Currently being removed Search for issues using JQL (GET)

Atlassian issueSearch.searchForIssuesUsingJql: arguments, response, policy and SDK examples.

Operation atlassian.searchforissuesusingjql

Provider route: GET /{cloudId}/rest/api/3/search. 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"]["searchForIssuesUsingJql"]>[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.searchForIssuesUsingJql(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_for_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.startAt`	integer	Optional	Default: 0 Format: int32
`query.maxResults`	integer	Optional	Default: 50 Format: int32
`query.validateQuery`	string	Optional	Default: strict One of: strict, warn, none, true, false
`query.fields`	array	Optional
`query.fields[]`	string	Each item	Default: *navigable
`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

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 Currently being removed Search for issues using JQL (GET) — response body

Referenced models: Currently being removed Search for issues using JQL (GET) — response body

Schemas

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

Currently being removed Search for issues using JQL (GET) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The result of a JQL search.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional search result details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	The list of issues found by the search. Read only: true
`issues (anyOf 1)[]`	Model	Each item	Expand Get issue — response body
`issues (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (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
`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
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`warningMessages`	JSON	Optional
`warningMessages (anyOf 1)`	array	Alternative	Any warnings related to the JQL query. Read only: true
`warningMessages (anyOf 1)[]`	string	Each item	Read only: true
`warningMessages (anyOf 2)`	null	Alternative

Referenced models: Get issue — response body, Create custom field — response body — schema The schema of a field

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

Get issue — response body — fields To Include actually Included, excluded, included

Field	Type	Presence	Description and constraints
`$`	object	Root
`actuallyIncluded`	JSON	Optional
`actuallyIncluded (anyOf 1)`	array	Alternative	Unique items: true
`actuallyIncluded (anyOf 1)[]`	string	Each item
`actuallyIncluded (anyOf 2)`	null	Alternative
`excluded`	JSON	Optional
`excluded (anyOf 1)`	array	Alternative	Unique items: true
`excluded (anyOf 1)[]`	string	Each item
`excluded (anyOf 2)`	null	Alternative
`included`	JSON	Optional
`included (anyOf 1)`	array	Alternative	Unique items: true
`included (anyOf 1)[]`	string	Each item
`included (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.searchforissuesusingjql. Catalog operation: searchforissuesusingjql. 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

Report an issue with this page