getField

Description

Get the value of a field for the given Jira issue.

Parameters

Returns

Returns a Promise to the value; you must use await.

Exact return type matches the field being accessed.

Examples

Return a string of the Summary field value of the current issue.

await api.issue.getField(issue, "summary") // “Implement SSO Login”

Return a datetime of the Actual Start field of the current issue.

await api.issue.getField(issue, "customfield_10008") // “2024-09-17T04:00:00.000-0400"

Return the Assignee of the current issue’s Parent.

const parentIssue = await api.issue.getParentIssue(issue)
const assignedTo = await api.issue.getFields(parentIssue, "assignee") // Returns a User Object

You are viewing the documentation for Jira Cloud.

On this page

Determining custom field IDs

There are several ways to determine the field ID of a custom field; the most straightforward is to check the URL of the custom field when editing its details through the Jira Custom fields screen. To find the ID of a custom field:

Log into Jira as an Administrator.
In the upper right corner of the window, click Settings ( ⚙️ ) and select Issues.
In the left-hand sidebar, click Custom fields.
Locate your custom field in the list; use the filter at the top of the list to search.
Click the action button at the far right ( ) and select Edit details.
Check the URL for the page that opens - the final argument of the URL is the field ID (Figure 1, right).
Append this value to “customfield_” to get the full ID of the field. For example, customfield_10130 is the field ID of Projected Due Date, shown in Figure 1, right.