Issue fields

Get fields for projects

Changed on

Returns a paginated list of fields for the requested projects and work types.

Only fields that are available for the specified combination of projects and work types are returned. This endpoint allows filtering to specific fields if field IDs are provided.

Permissions required: Permission to access Jira.

get/rest/api/3/projects/fields

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/projects/fields
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

projectIdinteger[] required

The IDs of projects to return fields for.

[
  10000,
  10001
]
workTypeIdinteger[] required

The IDs of work types (issue types) to return fields for.

[
  10000,
  10001
]
fieldIdstring[]

The IDs of fields to return. If not provided, all fields are returned.

[
  "summary",
  "description"
]

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes