Atlassian: Get fields paginated

Atlassian issueFields.getFieldsPaginated: arguments, response, policy and SDK examples.

Operation atlassian.getfieldspaginated

Provider route: GET /{cloudId}/rest/api/3/field/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["issueFields"]["getFieldsPaginated"]>[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.getFieldsPaginated(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_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.type`	array	Optional
`query.type[]`	string	Each item	Default: One of: custom, system
`query.id`	array	Optional	Unique items: true
`query.id[]`	string	Each item	Default:
`query.query`	string	Optional
`query.orderBy`	string	Optional	One of: contextsCount, -contextsCount, +contextsCount, lastUsed, -lastUsed, +lastUsed, name, -name, +name, screensCount, -screensCount, +screensCount, projectsCount, -projectsCount, +projectsCount
`query.expand`	string	Optional
`query.projectIds`	array	Optional	Unique items: true
`query.projectIds[]`	integer	Each item	Format: int64

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

Referenced models: Get fields paginated — response body

Schemas

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

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a field.
`contextsCount`	JSON	Optional
`contextsCount (anyOf 1)`	JSON	Alternative
`contextsCount (anyOf 1) (anyOf 1)`	integer	Alternative	Number of contexts where the field is used. Format: int64
`contextsCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`contextsCount (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the field.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the field.
`id (anyOf 2)`	null	Alternative
`isLocked`	JSON	Optional
`isLocked (anyOf 1)`	boolean	Alternative	Whether the field is locked.
`isLocked (anyOf 2)`	null	Alternative
`isUnscreenable`	JSON	Optional
`isUnscreenable (anyOf 1)`	boolean	Alternative	Whether the field is shown on screen or not.
`isUnscreenable (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the field.
`key (anyOf 2)`	null	Alternative
`lastUsed`	JSON	Optional
`lastUsed (anyOf 1)`	Model	Alternative	Expand Get fields paginated — response body — values The list of items item last Used Information about the most recent use of a field
`lastUsed (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the field.
`name (anyOf 2)`	null	Alternative
`projectsCount`	JSON	Optional
`projectsCount (anyOf 1)`	JSON	Alternative
`projectsCount (anyOf 1) (anyOf 1)`	integer	Alternative	Number of projects where the field is used. Format: int64
`projectsCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projectsCount (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	Model	Alternative	Expand Create custom field — response body — schema The schema of a field
`schema (anyOf 2)`	null	Alternative
`screensCount`	JSON	Optional
`screensCount (anyOf 1)`	JSON	Alternative
`screensCount (anyOf 1) (anyOf 1)`	integer	Alternative	Number of screens where the field is used. Format: int64
`screensCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`screensCount (anyOf 2)`	null	Alternative
`searcherKey`	JSON	Optional
`searcherKey (anyOf 1)`	string	Alternative	The searcher key of the field. Returned for custom fields.
`searcherKey (anyOf 2)`	null	Alternative
`stableId`	JSON	Optional
`stableId (anyOf 1)`	string	Alternative	The stable ID of the field.
`stableId (anyOf 2)`	null	Alternative
`translatedDescription`	JSON	Optional
`translatedDescription (anyOf 1)`	string	Alternative	The translated (i18n) description of the field for the current locale. Returned for custom fields.
`translatedDescription (anyOf 2)`	null	Alternative
`translatedName`	JSON	Optional
`translatedName (anyOf 1)`	string	Alternative	The translated (i18n) name of the field for the current locale. Returned for custom fields.
`translatedName (anyOf 2)`	null	Alternative
`typeDisplayName`	JSON	Optional
`typeDisplayName (anyOf 1)`	string	Alternative	The display name of the field type
`typeDisplayName (anyOf 2)`	null	Alternative

Referenced models: Get fields paginated — response body — values The list of items item last Used Information about the most recent use of a field, Create custom field — response body — schema The schema of a field

Get fields paginated — response body — values The list of items item last Used Information about the most recent use of a field

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about the most recent use of a field.
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Last used value type: * TRACKED: field is tracked and a last used date is available. * NOT\_TRACKED: field is not tracked, last used date is not available. * NO\_INFORMATION: field is tracked, but no last used date is available. Known values: TRACKED, NOT_TRACKED, NO_INFORMATION
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	JSON	Alternative
`value (anyOf 1) (anyOf 1)`	string	Alternative	The date when the value of the field last changed.
`value (anyOf 1) (anyOf 2)`	integer	Alternative
`value (anyOf 2)`	null	Alternative

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

Policy, approvals and errors

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