Jira

Jira Issue fields API

This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.

GitHub OpenAPI

Operations 11

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 · Get fields #
Ask an LLM
“What system and custom fields exist on my Jira site?”
“Can I get the full field list in one call without paging?”
Tell an agent
List every system and custom issue field.
Get all issue fields so I can find a custom field's ID.
POST /rest/api/3/field Create a custom field · Create custom field #
Ask an LLM
“How do I add a new custom field to issues?”
“Which searcher can I choose when creating a custom field?”
Tell an agent
Create a custom field named {name} of type {type}.
Create custom field {name} of type {type} with searcher {searcherKey} and description {description}.
GET /rest/api/3/field/search Search fields page by page · Get fields paginated #
Ask an LLM
“How do I search for fields whose name contains a word?”
“Can I page through only the custom fields used by certain projects?”
Tell an agent
Search fields matching {query}.
List fields of type {type} for projects {projectIds}, ordered by {orderBy}.
GET /rest/api/3/field/search/trashed List custom fields in the trash · Get fields in trash paginated #
Ask an LLM
“Which custom fields are currently in the trash?”
“Can I search trashed fields by name?”
Tell an agent
List the custom fields in the trash.
Find trashed fields matching {query}.
PUT /rest/api/3/field/{fieldId} Update a custom field's name, description or searcher · Update custom field #
Ask an LLM
“How do I rename a custom field?”
“Can I change a custom field's searcher after it's created?”
Tell an agent
Rename custom field {fieldId} to {name}.
Change custom field {fieldId}'s description to {description} and searcher to {searcherKey}.
GET /rest/api/3/field/{fieldId}/association/project List projects a custom field is associated with · Get field project associations #
Ask an LLM
“Which projects is a custom field associated with?”
“Can I page through the project associations of a field?”
Tell an agent
List the projects associated with custom field {fieldId}.
Show project associations for field {fieldId}, {maxResults} per page.
GET /rest/api/3/field/{fieldId}/contexts List a field's contexts via the deprecated endpoint · Get contexts for a field #
Ask an LLM
“Is there an older deprecated endpoint that lists the contexts a field is used in?”
“Does the legacy field contexts call still page its results?”
Tell an agent
Using the deprecated contexts endpoint, list the contexts field {fieldId} is used in.
Call the legacy /contexts path for field {fieldId} starting at {startAt}.
DELETE /rest/api/3/field/{id} Permanently delete a custom field · Delete custom field #
Ask an LLM
“How do I permanently delete a custom field, even if it's in the trash?”
“Is deleting a custom field reversible?”
Tell an agent destructive · confirm first
Permanently delete custom field {id}.
Delete custom field {id} for good, whether trashed or not.
POST /rest/api/3/field/{id}/restore Restore a custom field from the trash · Restore custom field from trash #
Ask an LLM
“Can I recover a custom field I moved to the trash?”
“How do I undo trashing a custom field?”
Tell an agent
Restore custom field {id} from the trash.
Bring trashed field {id} back.
POST /rest/api/3/field/{id}/trash Move a custom field to the trash · Move custom field to trash #
Ask an LLM
“How do I move a custom field to the trash without deleting it permanently?”
“What's the recoverable way to retire a custom field?”
Tell an agent
Move custom field {id} to the trash.
Trash field {id} so it can be restored later.
GET /rest/api/3/projects/fields List fields available for projects and work types · Get fields for projects #
Ask an LLM
“Which fields are available for a given project and work type combination?”
“Can I check whether a specific field is available for certain work types?”
Tell an agent
List the fields available in project {projectId} for work type {workTypeId}.
Check if field {fieldId} is available for project {projectId} and work type {workTypeId}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

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

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/jira:jira-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

jira-issue-fields-api-openapi.yml Raw ↑ 
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: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Issue fields API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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