Atlassian

Atlassian Issue Fields API

The Issue Fields API from Atlassian — 8 operation(s) for issue fields.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/field List all system and custom issue fields · Atlassian Get Fields #

Ask an LLM

“What fields, system and custom, exist on Jira issues in my site?”

“Where can I find the ID of a custom field like Story Points?”

Tell an agent

List every system and custom issue field in Jira.

Give me the full unpaginated field list so I can find custom field IDs.

POST /rest/api/3/field Create a custom field · Atlassian Create Custom Field #

Ask an LLM

“How do I add a new custom field to Jira issues?”

“Which searcher should I attach when creating a custom field?”

Tell an agent

Create a custom field named {name} of type {type}.

Add custom field {name} of type {type} with searcher {searcherKey} and description {description}.

GET /rest/api/3/field/search Search fields with filters and paging · Atlassian Get Fields Paginated #

Ask an LLM

“Can I search Jira fields by name and only get custom ones?”

“Is there a paginated way to list fields ordered by how often they're used?”

Tell an agent

Search fields whose name or description contains {query}.

List {type} fields ordered by {orderBy}, {maxResults} per page.

GET /rest/api/3/field/search/trashed List custom fields in the trash · Atlassian Get Fields In Trash Paginated #

Ask an LLM

“Which custom fields are sitting in the trash right now?”

“Can I search trashed fields by name before restoring one?”

Tell an agent

List the custom fields currently in the trash.

Find trashed custom fields matching {query}.

PUT /rest/api/3/field/{fieldId} Update a custom field's name or searcher · Atlassian Update Custom Field #

Ask an LLM

“How do I rename an existing custom field?”

“Can I change the searcher on a custom field after it's created?”

Tell an agent

Rename custom field {fieldId} to {name}.

Change the searcher of custom field {fieldId} to {searcherKey}.

GET /rest/api/3/field/{fieldId}/contexts List a field's contexts (deprecated) · Atlassian Get Contexts For A Field #

Ask an LLM

“Which contexts is a custom field used in, using the older contexts endpoint?”

“Is the older per-field contexts list deprecated in favour of the newer custom field contexts call?”

Tell an agent

List the contexts field {fieldId} is used in via the deprecated endpoint.

Get {maxResults} legacy contexts for custom field {fieldId}.

DELETE /rest/api/3/field/{id} Permanently delete a custom field · Atlassian Delete Custom Field #

Ask an LLM

“How do I permanently delete a custom field, even if it's not in the trash?”

“Is deleting a custom field done as an asynchronous task?”

Tell an agent destructive · confirm first

Permanently delete custom field {id}.

Erase custom field {id} for good, bypassing the trash.

POST /rest/api/3/field/{id}/restore Restore a custom field from trash · Atlassian Restore Custom Field From Trash #

Ask an LLM

“Can I bring back a custom field I moved to the trash?”

“How do I undo trashing a Jira custom field?”

Tell an agent

Restore custom field {id} from the trash.

Recover trashed field {id} so it's usable again.

POST /rest/api/3/field/{id}/trash Move a custom field to trash · Atlassian Move Custom Field To Trash #

Ask an LLM

“What's the recoverable way to get rid of a custom field?”

“Can I trash a custom field instead of deleting it outright?”

Tell an agent

Move custom field {id} to the trash.

Trash field {id} so it can still be restored later.

Documentation

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-webhooks/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-snippets/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-users/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit/

https://developer.atlassian.com/cloud/confluence/connect-modules/

https://developer.atlassian.com/cloud/confluence/rest/v2/intro/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template/

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-openapi

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/

https://developer.atlassian.com/server/framework/atlassian-sdk/audit/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/

https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/

https://developer.atlassian.com/cloud/jira/platform/connect-api-migration/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/

https://developer.atlassian.com/cloud/jira/platform/data-security-policy-developer-guide/

https://developer.atlassian.com/platform/forge/events-reference/jira/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters/

https://developer.atlassian.com/cloud/jira/platform/forge/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-types/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/

https://developer.atlassian.com/platform/marketplace/license-api-for-cloud-apps/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-priorities/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions/

https://developer.atlassian.com/server/jira/platform/webhooks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/

https://developer.atlassian.com/cloud/admin/organization/rest/

https://developer.atlassian.com/cloud/admin/user-management/rest/

https://developer.atlassian.com/cloud/admin/user-provisioning/rest/

Specifications

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-issue-fields-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-hook-events-paginated_hook_events-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-pull-requests-a_pullrequest_comment_task-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-repositories-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-snippets-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-teams-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-user-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-workspaces-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-body-async-content-body-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-states-async-id-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-group-group-array-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-inline-tasks-task-page-response-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-longtask-long-task-status-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-search-search-page-response-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-space-content-state-settings-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-template-blueprint-template-array-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-user-account-id-email-record-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-admin-domain-page-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-hook-events-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-pull-requests-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-repositories-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-snippets-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-teams-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-workspaces-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-audit-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-body-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-states-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-group-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-inline-tasks-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-longtask-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-relation-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-search-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-settings-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-space-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-template-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-admin-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/atlassian:atlassian-issue-fields-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://atlassian.com/terms/
  title: Atlassian The Jira Cloud platform REST Issue Fields API
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-issue-fields-api-openapi.yml