Atlassian: Get projects paginated

← Projects operations · Get started

Operation atlassian.searchprojects

Provider route: GET /{cloudId}/rest/api/3/project/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["projects"]["searchProjects"]>[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.searchProjects(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.search_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.startAt	integer	Optional	Default: 0 Format: int64
query.maxResults	integer	Optional	Default: 50 Format: int32 Maximum: 100
query.orderBy	string	Optional	Default: key One of: category, -category, +category, key, -key, +key, name, -name, +name, owner, -owner, +owner, issueCount, -issueCount, +issueCount, lastIssueUpdatedDate, -lastIssueUpdatedDate, +lastIssueUpdatedDate, archivedDate, +archivedDate, -archivedDate, deletedDate, +deletedDate, -deletedDate
query.id	array	Optional	Unique items: true
query.id[]	integer	Each item	Format: int64
query.keys	array	Optional	Unique items: true
query.keys[]	string	Each item	Default:
query.query	string	Optional
query.typeKey	string	Optional
query.categoryId	integer	Optional	Format: int64
query.action	string	Optional	Default: view One of: view, browse, edit, create
query.expand	string	Optional
query.status	array	Optional
query.status[]	string	Each item	Default: live One of: live, archived, deleted
query.properties	array	Optional
query.properties[]	Model	Each item	Expand Assign issue — request body — body groups callback
query.propertyQuery	string	Optional

Referenced models: Assign issue — request body — body groups callback

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

Referenced models: Get projects paginated — response body

Schemas

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

Assign issue — request body — body groups callback

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Get projects paginated — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of items.
isLast	JSON	Optional
isLast (anyOf 1)	boolean	Alternative	Whether this is the last page. Read only: true
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 Read only: true
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	If there is another page of results, the URL of the next page. Format: uri Read only: true
nextPage (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the page. Format: uri Read only: true
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. Format: int64 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 items returned. Format: int64 Read only: true
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. Read only: true
values (anyOf 1)[]	Model	Each item	Expand Get project — response body
values (anyOf 2)	null	Alternative

Referenced models: Get project — response body

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 — permissions Permissions which a user has on a project

Field	Type	Presence	Description and constraints
$	object	Root	Permissions which a user has on a project.
canEdit	JSON	Optional
canEdit (anyOf 1)	boolean	Alternative	Whether the logged user can edit the project. Read only: true
canEdit (anyOf 2)	null	Alternative

Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

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