Atlassian: Get workflows paginated

Atlassian workflows.getWorkflowsPaginated: arguments, response, policy and SDK examples.

Operation atlassian.getworkflowspaginated

Provider route: GET /{cloudId}/rest/api/3/workflow/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["workflows"]["getWorkflowsPaginated"]>[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.workflows.getWorkflowsPaginated(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.workflows.get_workflows_paginated(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
`query.workflowName`	array	Optional	Unique items: true
`query.workflowName[]`	string	Each item	Default:
`query.expand`	string	Optional
`query.queryString`	string	Optional
`query.orderBy`	string	Optional	One of: name, -name, +name, created, -created, +created, updated, +updated, -updated
`query.isActive`	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 Get workflows paginated — response body

Referenced models: Get workflows paginated — response body

Schemas

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

Get workflows 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 workflows paginated — response body — values The list of items item
`values (anyOf 2)`	null	Alternative

Referenced models: Get workflows paginated — response body — values The list of items item

Get workflows paginated — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a workflow.
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The creation date of the workflow.
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the workflow.
`description (anyOf 2)`	null	Alternative
`hasDraftWorkflow`	JSON	Optional
`hasDraftWorkflow (anyOf 1)`	boolean	Alternative	Whether the workflow has a draft version.
`hasDraftWorkflow (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item id Properties that identify a published workflow
`id (anyOf 2)`	null	Alternative
`isDefault`	JSON	Optional
`isDefault (anyOf 1)`	boolean	Alternative	Whether this is the default workflow.
`isDefault (anyOf 2)`	null	Alternative
`operations`	JSON	Optional
`operations (anyOf 1)`	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item operations Operations allowed on a workflow
`operations (anyOf 2)`	null	Alternative
`projects`	JSON	Optional
`projects (anyOf 1)`	array	Alternative	The projects the workflow is assigned to, through workflow schemes.
`projects (anyOf 1)[]`	Model	Each item	Expand Get issue type screen scheme projects — response body — values The list of items item
`projects (anyOf 2)`	null	Alternative
`schemes`	JSON	Optional
`schemes (anyOf 1)`	array	Alternative	The workflow schemes the workflow is assigned to.
`schemes (anyOf 1)[]`	Model	Each item	Expand Get workflows paginated — response body — values The list of items item schemes The workflow schemes the workflow is assigned to item
`schemes (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	The statuses of the workflow.
`statuses (anyOf 1)[]`	Model	Each item	Expand Get workflows paginated — response body — values The list of items item statuses The statuses of the workflow item
`statuses (anyOf 2)`	null	Alternative
`transitions`	JSON	Optional
`transitions (anyOf 1)`	array	Alternative	The transitions of the workflow.
`transitions (anyOf 1)[]`	Model	Each item	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item
`transitions (anyOf 2)`	null	Alternative
`updated`	JSON	Optional
`updated (anyOf 1)`	JSON	Alternative
`updated (anyOf 1) (anyOf 1)`	string	Alternative	The last edited date of the workflow.
`updated (anyOf 1) (anyOf 2)`	integer	Alternative
`updated (anyOf 2)`	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item, Get workflows paginated — response body — values The list of items item id Properties that identify a published workflow, Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item, Get workflows paginated — response body — values The list of items item operations Operations allowed on a workflow, Get workflows paginated — response body — values The list of items item schemes The workflow schemes the workflow is assigned to item, Get workflows paginated — response body — values The list of items item statuses The statuses of the workflow item

Get issue type screen scheme projects — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a project.
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The URLs of the project's avatars. Read only: true
`avatarUrls (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the project.
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the project. Read only: true
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the project. Read only: true
`name (anyOf 2)`	null	Alternative
`projectCategory`	JSON	Optional
`projectCategory (anyOf 1)`	Model	Alternative	Expand Update project category — response body The category the project belongs to. Read only: true
`projectCategory (anyOf 2)`	null	Alternative
`projectTypeKey`	JSON	Optional
`projectTypeKey (anyOf 1)`	string	Alternative	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. Known values: software, service_desk, business, product_discovery Read only: true
`projectTypeKey (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the project details. Read only: true
`self (anyOf 2)`	null	Alternative
`simplified`	JSON	Optional
`simplified (anyOf 1)`	boolean	Alternative	Whether or not the project is simplified. Read only: true
`simplified (anyOf 2)`	null	Alternative

Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Update project category — response body

Policy, approvals and errors

SDK function policy ID: atlassian.getworkflowspaginated. Catalog operation: getworkflowspaginated. 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-project"]

Official provider source

Report an issue with this page