Atlassian: Get plans paginated

Atlassian plans.getPlans: arguments, response, policy and SDK examples.

Operation atlassian.getplans

Provider route: GET /{cloudId}/rest/api/3/plans/plan. 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["plans"]["getPlans"]>[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.plans.getPlans(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.plans.get_plans(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.includeTrashed`	boolean	Optional	Default: false
`query.includeArchived`	boolean	Optional	Default: false
`query.cursor`	string	Optional	Default:
`query.maxResults`	integer	Optional	Default: 50 Format: int32

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

Referenced models: Get plans paginated — response body

Schemas

Get plans paginated — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`cursor`	JSON	Optional
`cursor (anyOf 1)`	string	Alternative
`cursor (anyOf 2)`	null	Alternative
`last`	JSON	Optional
`last (anyOf 1)`	boolean	Alternative
`last (anyOf 2)`	null	Alternative
`nextPageCursor`	JSON	Optional
`nextPageCursor (anyOf 1)`	string	Alternative
`nextPageCursor (anyOf 2)`	null	Alternative
`size`	JSON	Optional
`size (anyOf 1)`	JSON	Alternative
`size (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int32
`size (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`size (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	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
`values (anyOf 1)[]`	Model	Each item	Expand Get plans paginated — response body — values array item
`values (anyOf 2)`	null	Alternative

Referenced models: Get plans paginated — response body — values array item

Get plans paginated — response body — values array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The plan ID.
`id (anyOf 2)`	null	Alternative
`issueSources`	JSON	Optional
`issueSources (anyOf 1)`	array	Alternative	The issue sources included in the plan. Unique items: true
`issueSources (anyOf 1)[]`	Model	Each item	Expand Get plan — response body — issue Sources The issue sources included in the plan item
`issueSources (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The plan name.
`name (anyOf 2)`	null	Alternative
`scenarioId`	JSON	Optional
`scenarioId (anyOf 1)`	string	Alternative	Default scenario ID.
`scenarioId (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	The plan status. This is "Active", "Trashed" or "Archived". Known values: Active, Trashed, Archived
`status (anyOf 2)`	null	Alternative

Referenced models: Get plan — response body — issue Sources The issue sources included in the plan item

Get plan — response body — issue Sources The issue sources included in the plan item

Field	Type	Presence	Description and constraints
`$`	object	Root
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The issue source type. This is "Board", "Project" or "Filter". Known values: Board, Project, Filter, Custom
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	JSON	Alternative
`value (anyOf 1) (anyOf 1)`	integer	Alternative	The issue source value. This is a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter". Format: int64
`value (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`value (anyOf 2)`	null	Alternative

Policy, approvals and errors

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