Atlassian: Get all status categories

← Workflow status categories operations · Get started

Operation atlassian.getstatuscategories

Provider route: GET /{cloudId}/rest/api/3/statuscategory. 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["workflowStatusCategories"]["getStatusCategories"]>[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.workflowStatusCategories.getStatusCategories(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.workflow_status_categories.get_status_categories(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}$

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 status category — response body

Referenced models: Get status category — response body

Schemas

Get status category — response body

Field	Type	Presence	Description and constraints
$	object	Root	A status category. Additional keys: allowed
colorName	JSON	Optional
colorName (anyOf 1)	string	Alternative	The name of the color used to represent the status category. Read only: true
colorName (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the status category. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the status category. Read only: true
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the status category. Read only: true
name (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the status category. Read only: true
self (anyOf 2)	null	Alternative

Policy, approvals and errors

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