Atlassian: Get fields

← Issue fields operations · Get started

Operation atlassian.getfields

Provider route: GET /{cloudId}/rest/api/3/field. 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["issueFields"]["getFields"]>[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.issueFields.getFields(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.issue_fields.get_fields(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 Create custom field — response body

Referenced models: Create custom field — response body

Schemas

Create custom field — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a field.
clauseNames	JSON	Optional
clauseNames (anyOf 1)	array	Alternative	The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ). Unique items: true
clauseNames (anyOf 1)[]	string	Each item
clauseNames (anyOf 2)	null	Alternative
custom	JSON	Optional
custom (anyOf 1)	boolean	Alternative	Whether the field is a custom field.
custom (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the field.
id (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the field.
key (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the field.
name (anyOf 2)	null	Alternative
navigable	JSON	Optional
navigable (anyOf 1)	boolean	Alternative	Whether the field can be used as a column on the issue navigator.
navigable (anyOf 2)	null	Alternative
orderable	JSON	Optional
orderable (anyOf 1)	boolean	Alternative	Whether the content of the field can be used to order lists.
orderable (anyOf 2)	null	Alternative
schema	JSON	Optional
schema (anyOf 1)	Model	Alternative	Expand Create custom field — response body — schema The schema of a field The data schema for the field.
schema (anyOf 2)	null	Alternative
scope	JSON	Optional
scope (anyOf 1)	Model	Alternative	Expand Get status — response body — scope project, type The scope of the field.
scope (anyOf 2)	null	Alternative
searchable	JSON	Optional
searchable (anyOf 1)	boolean	Alternative	Whether the content of the field can be searched.
searchable (anyOf 2)	null	Alternative

Referenced models: Create custom field — response body — schema The schema of a field, Get status — response body — scope project, type

Create custom field — response body — schema The schema of a field

Field	Type	Presence	Description and constraints
$	object	Root	The schema of a field.
configuration	JSON	Optional
configuration (anyOf 1)	object	Alternative	If the field is a custom field, the configuration of the field. Read only: true Additional keys: see wildcard field
configuration (anyOf 1).*	JSON	Additional keys	Read only: true
configuration (anyOf 2)	null	Alternative
custom	JSON	Optional
custom (anyOf 1)	string	Alternative	If the field is a custom field, the URI of the field. Read only: true
custom (anyOf 2)	null	Alternative
customId	JSON	Optional
customId (anyOf 1)	JSON	Alternative
customId (anyOf 1) (anyOf 1)	integer	Alternative	If the field is a custom field, the custom ID of the field. Format: int64 Read only: true
customId (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customId (anyOf 2)	null	Alternative
items	JSON	Optional
items (anyOf 1)	string	Alternative	When the data type is an array, the name of the field items within the array. Read only: true
items (anyOf 2)	null	Alternative
system	JSON	Optional
system (anyOf 1)	string	Alternative	If the field is a system field, the name of the field. Read only: true
system (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The data type of the field. Read only: true
type (anyOf 2)	null	Alternative

Get status — response body — scope project, type

Field	Type	Presence	Description and constraints
$	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
project	JSON	Optional
project (anyOf 1)	Model	Alternative	Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true
project (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of scope. Known values: PROJECT, TEMPLATE Read only: true
type (anyOf 2)	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items 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

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

Update project category — response body

Field	Type	Presence	Description and constraints
$	object	Root	A project category.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The name of the project category. Read only: true
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 description of the project category. Read only: true
name (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the project category. Read only: true
self (anyOf 2)	null	Alternative

Policy, approvals and errors

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