The core issue fields returned by the Jira REST API.

Common system fields are typed explicitly; custom fields and any other keys are accessible via the index signature.

interface JiraIssueFields {
    assignee?: null | JiraUser;
    attachment?: JiraAttachment[];
    comment?: JiraCommentResponse;
    components?: JiraComponent[];
    created: string;
    creator?: null | JiraUser;
    description?: null | string;
    duedate?: null | string;
    environment?: null | string;
    fixVersions?: JiraVersion[];
    issuelinks?: JiraIssueLink[];
    issuetype: JiraIssueType;
    labels?: string[];
    parent?: null | JiraIssueRef;
    priority?: null | JiraPriority;
    project: JiraProjectRef;
    reporter?: null | JiraUser;
    resolution?: null | JiraResolution;
    resolutiondate?: null | string;
    status: JiraStatus;
    subtasks?: JiraSubtask[];
    summary: string;
    timetracking?: JiraTimeTracking;
    updated: string;
    versions?: JiraVersion[];
    votes?: JiraVotes;
    watches?: JiraWatchers;
    worklog?: JiraWorklogResponse;
    [key: string]: unknown;
}

Indexable

  • [key: string]: unknown

    Any additional fields (custom fields, etc.)

Properties

assignee?: null | JiraUser

Assigned user

attachment?: JiraAttachment[]

File attachments

Embedded comment page

components?: JiraComponent[]

Components

created: string

ISO 8601 creation timestamp

creator?: null | JiraUser

Creator user

description?: null | string

Issue description

duedate?: null | string

Due date in YYYY-MM-DD format

environment?: null | string

Environment description

fixVersions?: JiraVersion[]

Fix versions

issuelinks?: JiraIssueLink[]

Issue links

issuetype: JiraIssueType

Issue type

labels?: string[]

Labels

parent?: null | JiraIssueRef

Parent issue (for sub-tasks or issues in epics)

priority?: null | JiraPriority

Issue priority

The project this issue belongs to

reporter?: null | JiraUser

Reporter user

resolution?: null | JiraResolution

Resolution

resolutiondate?: null | string

ISO 8601 resolution timestamp

status: JiraStatus

Current workflow status

subtasks?: JiraSubtask[]

Sub-tasks

summary: string

Issue summary

timetracking?: JiraTimeTracking

Time tracking

updated: string

ISO 8601 last update timestamp

versions?: JiraVersion[]

Affected versions

votes?: JiraVotes

Votes

watches?: JiraWatchers

Watches

Embedded worklog page