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.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Jira work item.
| Field | Type | Description |
|---|---|---|
assignee | User | The user currently assigned to work on this Jira issue. May be null if unassigned. |
createdAt | DateTime | Timestamp indicating when the Jira issue was originally created. |
description | String | Detailed description of the Jira issue, which may include acceptance criteria, steps to reproduce, etc. |
dueAt | DateTime | The due date for an issue |
id | ID! | Unique identifier for the Jira work item. This ID is globally unique across the entire Teamwork Graph. |
issueId | ID | Issue ID in numeric format. E.g. 10000 |
issueType | JiraWorkItemType | The issue type object for an issue |
key | String | Jira issue key (e.g., "PROJ-123", "BUG-456"). This is the human-readable identifier used in Jira. |
reporter | User | The user who reported or created this Jira issue. |
resolvedAt | DateTime | The resolution date for an issue |
startedAt | DateTime | The start date for an issue |
status | JiraWorkItemStatus | The status for an issue |
summary | String | Brief title or summary of the Jira issue. |
webUrl | URL | The browser clickable link of this Issue. |
| Field | Type | Description |
|---|---|---|
avatar | JiraAvatar | Avatar of the issue type. |
description | String | Description of the issue type. |
id | ID! | Unique identifier for the issue type. This ID is globally unique across the entire Teamwork Graph. |
name | String | Name of the issue type. E.g. Story, Bug, Task, Epic. |
| Field | Type | Description |
|---|---|---|
large | String | A large avatar (48x48 pixels). |
medium | String | A medium avatar (32x32 pixels). |
small | String | A small avatar (24x24 pixels). |
xsmall | String | An extra-small avatar (16x16 pixels). |
| Field | Type | Description |
|---|---|---|
description | String | Optional description of the status. |
id | ID! | Unique identifier for the status. This ID is globally unique across the entire Teamwork Graph. |
name | String | Name of status. E.g. Backlog, Selected for Development, In Progress, Done. |
statusCategory | JiraStatusCategory | Represents a group of Jira statuses. |
statusId | ID | Status id in the digital format. |
| Field | Type | Description |
|---|---|---|
colorName | JiraStatusCategoryColor | Color of status category. |
id | ID! | Global identifier for the Status Category. |
key | String | A unique key to identify this status category. E.g. new, indeterminate, done. |
name | String | Name of status category. E.g. New, In Progress, Complete. |
statusCategoryId | ID | Status category id in the digital format. |
| Value | Description |
|---|---|
BLUE_GRAY | Blue gray color. |
BROWN | Brown color. |
GREEN | Green color. |
MEDIUM_GRAY | Medium gray color. |
WARM_RED | Warm red color. |
YELLOW | Yellow color. |
The following relationships are currently supported for Jira work item:
Relationships where Jira work item is the source object.
Rate this page: