Atlassian: Search statuses paginated

Atlassian status.search: arguments, response, policy and SDK examples.

Operation atlassian.search

Provider route: GET /{cloudId}/rest/api/3/statuses/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["status"]["search"]>[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.status.search(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.status.search(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.projectId`	string	Optional
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 200 Format: int32
`query.searchString`	string	Optional	Maximum length: 255
`query.statusCategory`	string	Optional
`query.includeGlobalStatuses`	boolean	Optional

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 statuses paginated — response body

Referenced models: Search statuses paginated — response body

Schemas

Search statuses paginated — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Whether this is the last page.
`isLast (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of items that could be returned. Format: int32
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	The URL of the next page of results, if any.
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of this page.
`self (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: int64
`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	Number of items that satisfy the search. Format: int64
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	The list of items.
`values (anyOf 1)[]`	Model	Each item	Expand Bulk get statuses — response body — item
`values (anyOf 2)`	null	Alternative

Referenced models: Bulk get statuses — response body — item

Bulk get statuses — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a status.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the status.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the status.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the status.
`name (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Bulk get statuses — response body — item scope The scope of the status
`scope (anyOf 2)`	null	Alternative
`statusCategory`	JSON	Optional
`statusCategory (anyOf 1)`	string	Alternative	The category of the status. Known values: TODO, IN_PROGRESS, DONE
`statusCategory (anyOf 2)`	null	Alternative

Referenced models: Bulk get statuses — response body — item scope The scope of the status

Bulk get statuses — response body — item scope The scope of the status

Field	Type	Presence	Description and constraints
`$`	object	Root	The scope of the status.
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Bulk get statuses — response body — item scope The scope of the status project value
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The scope of the status. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL
`type (anyOf 2)`	null	Alternative

Referenced models: Bulk get statuses — response body — item scope The scope of the status project value

Bulk get statuses — response body — item scope The scope of the status project value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Project ID details.
`$ (anyOf 1).id`	JSON	Optional
`$ (anyOf 1).id (anyOf 1)`	string	Alternative	The ID of the project.
`$ (anyOf 1).id (anyOf 2)`	null	Alternative
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.search. Catalog operation: search. 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: ["manage:jira-configuration"]

Official provider source

Report an issue with this page