JIRA 7.6.1
  1. Issue field configurations
JIRA 7.6.1
  • Announcement banner
    • Get announcement banner configuration
      GET
    • Update announcement banner configuration
      PUT
  • Issue custom field values (apps)
    • Update custom fields
      POST
    • Update custom field value
      PUT
  • Issue custom field configuration (apps)
    • Get custom field configurations
      GET
    • Update custom field configurations
      PUT
  • Jira settings
    • Get application property
      GET
    • Get advanced settings
      GET
    • Set application property
      PUT
    • Get global settings
      GET
  • Application roles
    • Get all application roles
    • Get application role
  • Issue attachments
    • Get attachment content
    • Get Jira attachment settings
    • Get attachment thumbnail
    • Get attachment metadata
    • Delete attachment
    • Get all metadata for an expanded attachment
    • Get contents metadata for an expanded attachment
    • Add attachment
  • Audit records
    • Get audit records
  • Avatars
    • Get system avatars by type
    • Get avatars
    • Load avatar
    • Delete avatar
    • Get avatar image by type
    • Get avatar image by ID
    • Get avatar image by owner
  • Issue comments
    • Get comments by IDs
    • Get comments
    • Add comment
    • Get comment
    • Update comment
    • Delete comment
  • Issue comment properties
    • Get comment property keys
    • Get comment property
    • Set comment property
    • Delete comment property
  • Project components
    • Create component
    • Get component
    • Update component
    • Delete component
    • Get component issues count
    • Get project components paginated
    • Get project components
  • Time tracking
    • Get selected time tracking provider
    • Select time tracking provider
    • Get all time tracking providers
    • Get time tracking settings
    • Set time tracking settings
  • Issue custom field options
    • Get custom field option
    • Get custom field options (context)
    • Update custom field options (context)
    • Create custom field options (context)
    • Reorder custom field options (context)
    • Delete custom field options (context)
  • Dashboards
    • Get all dashboards
    • Create dashboard
    • Get available gadgets
    • Search for dashboards
    • Get gadgets
    • Add gadget to dashboard
    • Update gadget on dashboard
    • Remove gadget from dashboard
    • Get dashboard item property keys
    • Get dashboard item property
    • Set dashboard item property
    • Delete dashboard item property
    • Get dashboard
    • Update dashboard
    • Delete dashboard
    • Copy dashboard
  • Issues
    • Get events
    • Create issue
    • Bulk create issue
    • Get create issue metadata
    • Get issue
    • Edit issue
    • Delete issue
    • Assign issue
    • Get changelogs
    • Get changelogs by IDs
    • Get edit issue metadata
    • Send notification for issue
    • Get transitions
    • Transition issue
  • Jira expressions
    • Analyse Jira expression
    • Evaluate Jira expression
  • Issue fields
    • Get fields
    • Create custom field
    • Get fields paginated
    • Get fields in trash paginated
    • Update custom field
    • Get contexts for a field
    • Delete custom field
    • Restore custom field from trash
    • Move custom field to trash
  • Issue custom field contexts
    • Get custom field contexts
    • Create custom field context
    • Get custom field contexts default values
    • Set custom field contexts default values
    • Get issue types for custom field context
    • Get custom field contexts for projects and issue types
    • Get project mappings for custom field context
    • Update custom field context
    • Delete custom field context
    • Add issue types to context
    • Remove issue types from context
    • Assign custom field context to projects
    • Remove custom field context from projects
  • Screens
    • Get screens for a field
    • Get screens
    • Create screen
    • Add field to default screen
    • Update screen
    • Delete screen
    • Get available screen fields
  • Issue custom field options (apps)
    • Get all issue field options
    • Create issue field option
    • Get selectable issue field options
    • Get visible issue field options
    • Get issue field option
    • Update issue field option
    • Delete issue field option
    • Replace issue field option
  • Issue field configurations
    • Get all field configurations
      GET
    • Create field configuration
      POST
    • Update field configuration
      PUT
    • Delete field configuration
      DELETE
    • Get field configuration items
      GET
    • Update field configuration items
      PUT
    • Get all field configuration schemes
      GET
    • Create field configuration scheme
      POST
    • Get field configuration issue type items
      GET
    • Get field configuration schemes for projects
      GET
    • Assign field configuration scheme to project
      PUT
    • Update field configuration scheme
      PUT
    • Delete field configuration scheme
      DELETE
    • Assign issue types to field configurations
      PUT
    • Remove issue types from field configuration scheme
      POST
  • Filters
    • Create filter
    • Get favorite filters
    • Get my filters
    • Search for filters
    • Get filter
    • Update filter
    • Delete filter
    • Get columns
    • Set columns
    • Reset columns
    • Add filter as favorite
    • Remove filter as favorite
    • Change filter owner
  • Filter sharing
    • Get default share scope
    • Set default share scope
    • Get share permissions
    • Add share permission
    • Get share permission
    • Delete share permission
  • Groups
    • Get group
    • Create group
    • Remove group
    • Bulk get groups
    • Get users from group
    • Add user to group
    • Remove user from group
    • Find groups
  • Group and user picker
    • Find users and groups
  • License metrics
    • Get license
    • Get approximate license count
    • Get approximate application license count
  • Issue search
    • Get issue picker suggestions
    • Check issues against JQL
    • Search for issues using JQL (GET)
    • Search for issues using JQL (POST)
  • Issue properties
    • Bulk set issues properties by list
    • Bulk set issue properties by issue
    • Bulk set issue property
    • Bulk delete issue property
    • Get issue property keys
    • Get issue property
    • Set issue property
    • Delete issue property
  • Issue watchers
    • Get is watching issue bulk
    • Get issue watchers
    • Add watcher
    • Delete watcher
  • Issue remote links
    • Get remote issue links
    • Create or update remote issue link
    • Delete remote issue link by global ID
    • Get remote issue link by ID
    • Update remote issue link by ID
    • Delete remote issue link by ID
  • Issue votes
    • Get votes
    • Add vote
    • Delete vote
  • Issue worklogs
    • Get issue worklogs
    • Add worklog
    • Get worklog
    • Update worklog
    • Delete worklog
    • Get IDs of deleted worklogs
    • Get worklogs
    • Get IDs of updated worklogs
  • Issue worklog properties
    • Get worklog property keys
    • Get worklog property
    • Set worklog property
    • Delete worklog property
  • Issue links
    • Create issue link
    • Get issue link
    • Delete issue link
  • Issue link types
    • Get issue link types
    • Create issue link type
    • Get issue link type
    • Update issue link type
    • Delete issue link type
  • Issue security schemes
    • Get issue security schemes
    • Create issue security scheme
    • Get issue security levels
    • Set default issue security levels
    • Get issue security level members
    • Get projects using issue security schemes
    • Associate security scheme to project
    • Search issue security schemes
    • Get issue security scheme
    • Update issue security scheme
    • Delete issue security scheme
    • Add issue security levels
    • Update issue security level
    • Remove issue security level
    • Add issue security level members
    • Remove member from issue security level
  • Issue security level
    • Get issue security level members
    • Get issue security level
  • Issue types
    • Get all issue types for user
    • Create issue type
    • Get issue types for project
    • Get issue type
    • Update issue type
    • Delete issue type
    • Get alternative issue types
    • Load issue type avatar
  • Issue type properties
    • Get issue type property keys
    • Get issue type property
    • Set issue type property
    • Delete issue type property
  • Issue type schemes
    • Get all issue type schemes
    • Create issue type scheme
    • Get issue type scheme items
    • Get issue type schemes for projects
    • Assign issue type scheme to project
    • Update issue type scheme
    • Delete issue type scheme
    • Add issue types to issue type scheme
    • Change order of issue types
    • Remove issue type from issue type scheme
  • Issue type screen schemes
    • Get issue type screen schemes
    • Create issue type screen scheme
    • Get issue type screen scheme items
    • Get issue type screen schemes for projects
    • Assign issue type screen scheme to project
    • Update issue type screen scheme
    • Delete issue type screen scheme
    • Append mappings to issue type screen scheme
    • Update issue type screen scheme default screen scheme
    • Remove mappings from issue type screen scheme
    • Get issue type screen scheme projects
  • JQL
    • Get field reference data (GET)
    • Get field reference data (POST)
    • Get field auto complete suggestions
    • Parse JQL query
    • Convert user identifiers to account IDs in JQL queries
    • Sanitize JQL queries
  • JQL functions (apps)
    • Get precomputations (apps)
    • Update precomputations (apps)
  • Labels
    • Get all labels
  • Permissions
    • Get my permissions
    • Get all permissions
    • Get bulk permissions
    • Get permitted projects
  • Myself
    • Get preference
    • Set preference
    • Delete preference
    • Get locale
    • Set locale
    • Delete locale
    • Get current user
  • Issue notification schemes
    • Get notification schemes paginated
    • Create notification scheme
    • Get projects using notification schemes paginated
    • Get notification scheme
    • Update notification scheme
    • Add notifications to notification scheme
    • Delete notification scheme
    • Remove notification from notification scheme
  • Permission schemes
    • Get all permission schemes
    • Create permission scheme
    • Get permission scheme
    • Update permission scheme
    • Delete permission scheme
    • Get permission scheme grants
    • Create permission grant
    • Get permission scheme grant
    • Delete permission scheme grant
  • Issue priorities
    • Get priorities
    • Create priority
    • Set default priority
    • Move priorities
    • Search priorities
    • Get priority
    • Update priority
    • Delete priority
  • Projects
    • Get all projects
    • Create project
    • Get recent projects
    • Get projects paginated
    • Get project
    • Update project
    • Delete project
    • Archive project
    • Delete project asynchronously
    • Restore deleted or archived project
    • Get all statuses for project
    • Get project issue type hierarchy
    • Get project notification scheme
  • Project types
    • Get all project types
    • Get licensed project types
    • Get project type by key
    • Get accessible project type by key
  • Project avatars
    • Set project avatar
    • Delete project avatar
    • Load project avatar
    • Get all project avatars
  • Project features
    • Get project features
    • Set project feature state
  • Project properties
    • Get project property keys
    • Get project property
    • Set project property
    • Delete project property
  • Project roles
    • Get project roles for project
    • Get project role for project
    • Get project role details
    • Get all project roles
    • Create project role
    • Get project role by ID
    • Fully update project role
    • Partial update project role
    • Delete project role
  • Project role actors
    • Set actors for project role
    • Add actors to project role
    • Delete actors from project role
    • Get default actors for project role
    • Add default actors to project role
    • Delete default actors from project role
  • Project versions
    • Get project versions paginated
    • Get project versions
    • Create version
    • Get version
    • Update version
    • Delete version
    • Merge versions
    • Move version
    • Get version's related issues count
    • Delete and replace version
    • Get version's unresolved issues count
  • Project email
    • Get project's sender email
    • Set project's sender email
  • Project permission schemes
    • Get project issue security scheme
    • Get assigned permission scheme
    • Assign permission scheme
    • Get project issue security levels
  • Project categories
    • Get all project categories
    • Create project category
    • Get project category by ID
    • Update project category
    • Delete project category
  • Project key and name validation
    • Validate project key
    • Get valid project key
    • Get valid project name
  • Issue resolutions
    • Get resolutions
    • Create resolution
    • Set default resolution
    • Move resolutions
    • Search resolutions
    • Get resolution
    • Update resolution
    • Delete resolution
  • Screen tabs
    • Get all screen tabs
    • Create screen tab
    • Update screen tab
    • Delete screen tab
    • Move screen tab
  • Screen tab fields
    • Get all screen tab fields
    • Add screen tab field
    • Remove screen tab field
    • Move screen tab field
  • Screen schemes
    • Get screen schemes
    • Create screen scheme
    • Update screen scheme
    • Delete screen scheme
  • Server info
    • Get Jira instance info
  • Issue navigator settings
    • Get issue navigator default columns
    • Set issue navigator default columns
  • Workflow statuses
    • Get all statuses
    • Get status
  • Workflow status categories
    • Get all status categories
    • Get status category
  • Status
    • Bulk get statuses
    • Bulk update statuses
    • Bulk create statuses
    • Bulk delete Statuses
    • Search statuses paginated
  • Tasks
    • Get task
    • Cancel task
  • UI modifications (apps)
    • Get UI modifications
    • Create UI modification
    • Update UI modification
    • Delete UI modification
  • Users
    • Get user
    • Create user
    • Delete user
    • Bulk get users
    • Get account IDs for users
    • Get user default columns
    • Set user default columns
    • Reset user default columns
    • Get user email
    • Get user email bulk
    • Get user groups
    • Get all users default
    • Get all users
  • User search
    • Find users assignable to projects
    • Find users assignable to issues
    • Find users with permissions
    • Find users for picker
    • Find users
    • Find users by query
    • Find user keys by query
    • Find users with browse permission
  • User properties
    • Get user property keys
    • Get user property
    • Set user property
    • Delete user property
  • Webhooks
    • Get dynamic webhooks for app
    • Register dynamic webhooks
    • Delete webhooks by ID
    • Get failed webhooks
    • Extend webhook life
  • Workflows
    • Get all workflows
    • Create workflow
    • Get workflows paginated
    • Delete inactive workflow
    • Bulk get workflows
    • Get available workflow capabilities
    • Bulk create workflows
    • Validate create workflows
    • Bulk update workflows
    • Validate update workflows
  • Workflow transition rules
    • Get workflow transition rule configurations
    • Update workflow transition rule configurations
    • Delete workflow transition rule configurations
  • Workflow transition properties
    • Get workflow transition properties
    • Update workflow transition property
    • Create workflow transition property
    • Delete workflow transition property
  • Workflow schemes
    • Get all workflow schemes
    • Create workflow scheme
    • Get workflow scheme
    • Update workflow scheme
    • Delete workflow scheme
    • Get default workflow
    • Update default workflow
    • Delete default workflow
    • Get workflow for issue type in workflow scheme
    • Set workflow for issue type in workflow scheme
    • Delete workflow for issue type in workflow scheme
    • Get issue types for workflows in workflow scheme
    • Set issue types for workflow in workflow scheme
    • Delete issue types for workflow in workflow scheme
  • Workflow scheme project associations
    • Get workflow scheme project associations
    • Assign workflow scheme to project
  • Workflow scheme drafts
    • Create draft workflow scheme
    • Get draft workflow scheme
    • Update draft workflow scheme
    • Delete draft workflow scheme
    • Get draft default workflow
    • Update draft default workflow
    • Delete draft default workflow
    • Get workflow for issue type in draft workflow scheme
    • Set workflow for issue type in draft workflow scheme
    • Delete workflow for issue type in draft workflow scheme
    • Publish draft workflow scheme
    • Get issue types for workflows in draft workflow scheme
    • Set issue types for workflow in workflow scheme
    • Delete issue types for workflow in draft workflow scheme
  • App properties
    • Get app properties
    • Get app property
    • Set app property
    • Delete app property
    • Set app property (Forge)
    • Delete app property (Forge)
  • Dynamic modules
    • Get modules
    • Register modules
    • Remove modules
  • App migration
    • Bulk update custom field value
    • Bulk update entity properties
    • Get workflow transition rule configurations
  1. Issue field configurations

Get field configuration items

GET
/rest/api/3/fieldconfiguration/{id}/fields
Returns a paginated list of all fields for a configuration.
Only the fields from configurations used in company-managed (classic) projects are returned.
Permissions required: Administer Jira global permission.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/fieldconfiguration//fields'
Response Response Example
200 - Success
{"maxResults":50,"startAt":0,"total":2,"isLast":true,"values":[{"id":"environment","description":"For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).","isHidden":false,"isRequired":false},{"id":"description","isHidden":false,"isRequired":false}]}

Request

Path Params
id
integer 
required
The ID of the field configuration.
Query Params
startAt
integer 
optional
The index of the first item to return in a page of results (page offset).
maxResults
integer 
optional
The maximum number of items to return per page.

Responses

🟢200Returned if the request is successful.
application/json
Body
A page of items.
isLast
boolean 
read-onlyoptional
Whether this is the last page.
maxResults
integer <int32>
read-onlyoptional
The maximum number of items that could be returned.
nextPage
string <uri>
read-onlyoptional
If there is another page of results, the URL of the next page.
self
string <uri>
read-onlyoptional
The URL of the page.
startAt
integer <int64>
read-onlyoptional
The index of the first item returned.
total
integer <int64>
read-onlyoptional
The number of items returned.
values
array[object (FieldConfigurationItem) {5}] 
read-onlyoptional
The list of items.
description
string 
optional
The description of the field within the field configuration.
id
string 
required
The ID of the field within the field configuration.
isHidden
boolean 
optional
Whether the field is hidden in the field configuration.
isRequired
boolean 
optional
Whether the field is required in the field configuration.
renderer
string 
optional
The renderer type for the field within the field configuration.
🟠401Returned if the authentication credentials are incorrect or missing.
🟠403Returned if the user does not have the necessary permission.
🟠404Returned if the field configuration is not found.
Modified at 2023-07-13 03:27:27
Previous
Delete field configuration
Next
Update field configuration items
Built with