Atlassian: Get all projects

Atlassian projects.getAllProjects: arguments, response, policy and SDK examples.

Operation atlassian.getallprojects

Provider route: GET /{cloudId}/rest/api/3/project. 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["projects"]["getAllProjects"]>[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.projects.getAllProjects(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.projects.get_all_projects(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.expand`	string	Optional
`query.recent`	integer	Optional	Format: int32
`query.properties`	array	Optional
`query.properties[]`	string	Each item	Default:

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
`$`	array	Root
`$[]`	Model	Each item	Expand Get project — response body

Referenced models: Get project — response body

Schemas

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

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Get project — response body — issue Type Hierarchy The project issue type hierarchy

Field	Type	Presence	Description and constraints
`$`	object	Root	The project issue type hierarchy.
`baseLevelId`	JSON	Optional
`baseLevelId (anyOf 1)`	JSON	Alternative
`baseLevelId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64
`baseLevelId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`baseLevelId (anyOf 2)`	null	Alternative
`levels`	JSON	Optional
`levels (anyOf 1)`	array	Alternative	Details about the hierarchy level. Read only: true
`levels (anyOf 1)[]`	Model	Each item	Expand Get project — response body — issue Type Hierarchy The project issue type hierarchy levels Details about the hierarchy level item
`levels (anyOf 2)`	null	Alternative

Referenced models: Get project — response body — issue Type Hierarchy The project issue type hierarchy levels Details about the hierarchy level item

Get issue type — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about an issue type.
`avatarId`	JSON	Optional
`avatarId (anyOf 1)`	JSON	Alternative
`avatarId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the issue type's avatar. Format: int64 Read only: true
`avatarId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`avatarId (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the issue type. Read only: true
`description (anyOf 2)`	null	Alternative
`entityId`	JSON	Optional
`entityId (anyOf 1)`	string	Alternative	Unique ID for next-gen projects. Format: uuid Read only: true
`entityId (anyOf 2)`	null	Alternative
`hierarchyLevel`	JSON	Optional
`hierarchyLevel (anyOf 1)`	JSON	Alternative
`hierarchyLevel (anyOf 1) (anyOf 1)`	integer	Alternative	Hierarchy level of the issue type. Format: int32 Read only: true
`hierarchyLevel (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hierarchyLevel (anyOf 2)`	null	Alternative
`iconUrl`	JSON	Optional
`iconUrl (anyOf 1)`	string	Alternative	The URL of the issue type's avatar. Read only: true
`iconUrl (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the issue type. Read only: true
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the issue type. Read only: true
`name (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type Details of the next-gen projects the issue type is available in. Read only: true
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of these issue type details. Read only: true
`self (anyOf 2)`	null	Alternative
`subtask`	JSON	Optional
`subtask (anyOf 1)`	boolean	Alternative	Whether this issue type is used to create subtasks. Read only: true
`subtask (anyOf 2)`	null	Alternative

Referenced models: Get status — response body — scope project, type

Create project category — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A project category.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the project category.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the project category. Read only: true
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the project category. Required on create, optional on update.
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the project category. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Get project — response body — insight Additional details about a project

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional details about a project.
`lastIssueUpdateTime`	JSON	Optional
`lastIssueUpdateTime (anyOf 1)`	JSON	Alternative
`lastIssueUpdateTime (anyOf 1) (anyOf 1)`	string	Alternative	The last issue update time. Read only: true
`lastIssueUpdateTime (anyOf 1) (anyOf 2)`	integer	Alternative
`lastIssueUpdateTime (anyOf 2)`	null	Alternative
`totalIssueCount`	JSON	Optional
`totalIssueCount (anyOf 1)`	JSON	Alternative
`totalIssueCount (anyOf 1) (anyOf 1)`	integer	Alternative	Total issue count. Format: int64 Read only: true
`totalIssueCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`totalIssueCount (anyOf 2)`	null	Alternative

Get project — response body — landing Page Info attributes, board Id, board Name, project Key, project Type, queue Category, queue Id, queue Name, simple Board, simplified, url

Field	Type	Presence	Description and constraints
`$`	object	Root
`attributes`	JSON	Optional
`attributes (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`attributes (anyOf 1).*`	string	Additional keys
`attributes (anyOf 2)`	null	Alternative
`boardId`	JSON	Optional
`boardId (anyOf 1)`	JSON	Alternative
`boardId (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`boardId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`boardId (anyOf 2)`	null	Alternative
`boardName`	JSON	Optional
`boardName (anyOf 1)`	string	Alternative
`boardName (anyOf 2)`	null	Alternative
`projectKey`	JSON	Optional
`projectKey (anyOf 1)`	string	Alternative
`projectKey (anyOf 2)`	null	Alternative
`projectType`	JSON	Optional
`projectType (anyOf 1)`	string	Alternative
`projectType (anyOf 2)`	null	Alternative
`queueCategory`	JSON	Optional
`queueCategory (anyOf 1)`	string	Alternative
`queueCategory (anyOf 2)`	null	Alternative
`queueId`	JSON	Optional
`queueId (anyOf 1)`	JSON	Alternative
`queueId (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`queueId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`queueId (anyOf 2)`	null	Alternative
`queueName`	JSON	Optional
`queueName (anyOf 1)`	string	Alternative
`queueName (anyOf 2)`	null	Alternative
`simpleBoard`	JSON	Optional
`simpleBoard (anyOf 1)`	boolean	Alternative
`simpleBoard (anyOf 2)`	null	Alternative
`simplified`	JSON	Optional
`simplified (anyOf 1)`	boolean	Alternative
`simplified (anyOf 2)`	null	Alternative
`url`	JSON	Optional
`url (anyOf 1)`	string	Alternative
`url (anyOf 2)`	null	Alternative

Policy, approvals and errors

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