Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jan 8, 2026

Jira work item

The Teamwork Graph API is available through Forge's Early Access Program (EAP).

EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.

You must only install apps that call the Teamwork Graph API in test organizations. Apps calling the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization. While apps still respect end-user permissions, this scope may grant access to sensitive information. For safety, only install these apps in organizations with test data. Do not install apps using this API in organizations with production data while this feature is in EAP.

Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.

You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.

Represents a work item from Jira (issue, task, story, bug, etc.). Extends the base WorkItem interface with Jira-specific fields for user assignments.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

  • Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
  • Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Jira work item.

FieldTypeDescription
assigneeUserThe user currently assigned to work on this Jira issue. May be null if unassigned.
createdAtDateTimeTimestamp indicating when the Jira issue was originally created.
descriptionStringDetailed description of the Jira issue, which may include acceptance criteria, steps to reproduce, etc.
dueAtDateTimeThe due date for an issue
idID!Unique identifier for the Jira work item. This ID is globally unique across the entire Teamwork Graph.
issueIdIDIssue ID in numeric format. E.g. 10000
issueTypeJiraWorkItemTypeThe issue type object for an issue
keyStringJira issue key (e.g., "PROJ-123", "BUG-456"). This is the human-readable identifier used in Jira.
reporterUserThe user who reported or created this Jira issue.
resolvedAtDateTimeThe resolution date for an issue
startedAtDateTimeThe start date for an issue
statusJiraWorkItemStatusThe status for an issue
summaryStringBrief title or summary of the Jira issue.
webUrlURLThe browser clickable link of this Issue.

Fields for JiraWorkItemType

FieldTypeDescription
avatarJiraAvatarAvatar of the issue type.
descriptionStringDescription of the issue type.
idID!Unique identifier for the issue type. This ID is globally unique across the entire Teamwork Graph.
nameStringName of the issue type. E.g. Story, Bug, Task, Epic.

Fields for JiraAvatar

FieldTypeDescription
largeStringA large avatar (48x48 pixels).
mediumStringA medium avatar (32x32 pixels).
smallStringA small avatar (24x24 pixels).
xsmallStringAn extra-small avatar (16x16 pixels).

Fields for JiraWorkItemStatus

FieldTypeDescription
descriptionStringOptional description of the status.
idID!Unique identifier for the status. This ID is globally unique across the entire Teamwork Graph.
nameStringName of status. E.g. Backlog, Selected for Development, In Progress, Done.
statusCategoryJiraStatusCategoryRepresents a group of Jira statuses.
statusIdIDStatus id in the digital format.

Fields for JiraStatusCategory

FieldTypeDescription
colorNameJiraStatusCategoryColorColor of status category.
idID!Global identifier for the Status Category.
keyStringA unique key to identify this status category. E.g. new, indeterminate, done.
nameStringName of status category. E.g. New, In Progress, Complete.
statusCategoryIdIDStatus category id in the digital format.

Values for JiraStatusCategoryColor

ValueDescription
BLUE_GRAYBlue gray color.
BROWNBrown color.
GREENGreen color.
MEDIUM_GRAYMedium gray color.
WARM_REDWarm red color.
YELLOWYellow color.

Available relationships

The following relationships are currently supported for Jira work item:

Relationships where Jira work item is the source object.

Relationship nameFrom object typeTo object type
Jira work item links external commitJira work itemExternal commit
Jira work item links support escalation entityJira work itemJira space
Jira work item
External message mentions Jira work itemJira work itemExternal messages
Jira work item links external buildJira work itemExternal build
Jira work item links external pull requestJira work itemExternal pull request
JSM incident links Jira post incident reviewJira work itemJira work item
Jira work item links external branchJira work itemExternal branch
Jira work item has Jira priorityJira work itemJira work item priority
Jira work item has child Jira work itemJira work itemJira work item
Jira work item links external deploymentJira work itemExternal deployment
Jira work item links Confluence whiteboardJira work itemConfluence whiteboard
Jira work item links external feature flagJira work itemExternal feature flag
Jira work item has changed Jira priorityJira work itemJira work item priority
External conversation mentions Jira work itemJira work itemExternal conversation
JSM incident links Jira work itemJira work itemJira work item
Jira work item has Jira work item commentJira work itemJira work item comment
Jira work item links Jira work itemJira work itemJira work item
Jira work item contributes to Atlassian goalJira work itemAtlassian goal
Jira work item links external designJira work itemExternal design
Jira work item has changed Jira statusJira work itemJira work item status
Jira work item blocks Jira work itemJira work itemJira work item
JSM incident links JSM post incident review linkJira work itemJira work item

Rate this page: