• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Project features

Postman Collection
OpenAPI

This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects.

GET

Get project features

Returns the list of features for a project.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredREAD

ClassicRECOMMENDED:read:jira-work
Granular:read:project.feature:jira

Request

Path parameters

projectIdOrKey

string

Required

Responses

Returned if the request is successful.

application/json

ContainerForProjectFeatures

The list of features on a project.

GET/rest/api/3/project/{projectIdOrKey}/features
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/features`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "features": [ { "feature": "jsw.classic.roadmap", "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg", "localisedDescription": "Your roadmap is an optimized location to create and manage your epics.", "localisedName": "Roadmap", "prerequisites": [], "projectId": 10001, "state": "ENABLED", "toggleLocked": true }, { "feature": "jsw.classic.backlog", "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg", "localisedDescription": "Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.", "localisedName": "Backlog", "prerequisites": [], "projectId": 10001, "state": "ENABLED", "toggleLocked": true } ] }
PUT

Set project feature state

Sets the state of a project feature.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredPROJECT_ADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:write:project.feature:jira, read:project.feature:jira

Request

Path parameters

projectIdOrKey

string

Required
featureKey

string

Required

Request bodyapplication/json

Details of the feature state change.

state

string

Responses

Returned if the request is successful.

application/json

ContainerForProjectFeatures

The list of features on a project.

PUT/rest/api/3/project/{projectIdOrKey}/features/{featureKey}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "state": "ENABLED" }`; const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/features/{featureKey}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "features": [ { "feature": "jsw.classic.roadmap", "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-roadmap-feature.svg", "localisedDescription": "Your roadmap is an optimized location to create and manage your epics.", "localisedName": "Roadmap", "prerequisites": [], "projectId": 10001, "state": "ENABLED", "toggleLocked": true }, { "feature": "jsw.classic.backlog", "imageUri": "https://jira.atlassian.com/s/sb53l8/b/3/ab8a7691e4738b4f147e293f0864adfd5b8d3c85/_/download/resources/com.atlassian.jira.rest:classic-project-features/simple-backlog-feature.svg", "localisedDescription": "Plan and prioritize work in a dedicated space. To enable and configure the backlog for each board, go to board settings.", "localisedName": "Backlog", "prerequisites": [], "projectId": 10001, "state": "ENABLED", "toggleLocked": true } ] }

Rate this page: