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 an external project management or task tracking system. External work items include tickets, tasks, or issues integrated from third-party project management platforms.
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 External work item.
| Field | Type | Description |
|---|---|---|
assignee | User | User assigned to work on this work item. |
collaborators | [User] | List of users collaborating on this work item. |
createdAt | DateTime | Timestamp when the work item was created. |
creator | User | User who created this work item. |
description | String | Description or detailed information about the work item. |
displayName | String | Display name or title of the work item. |
dueAt | DateTime | Due date for when the work item should be completed. |
exceedsMaxCollaborators | Boolean | Indicates whether the number of collaborators exceeds the maximum display limit. |
externalId | ID | Identifier of the work item in the external system. |
id | ID! | Unique identifier for the work item. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User who last edited this work item. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the work item. |
provider | ExternalProvider | Provider or integration that supplies this work item. |
status | String | Current status of the work item (e.g., "OPEN", "IN_PROGRESS", "COMPLETED"). |
subtype | ExternalWorkItemSubtype | Subtype or classification of the work item. |
team | String | Team or group responsible for this work item. |
url | URL | Direct URL to view the work item in its source system. |
workItemProject | ExternalWorkItemProject | Project that contains this work item. |
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the external provider. |
logoUrl | URL | URL to the provider's logo image for UI display. |
name | String | Display name of the provider (e.g., "Google Drive", "Dropbox", "GitHub"). |
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the project. |
name | String | Display name of the project. |
| Value | Description |
|---|---|
APPROVAL | The work item is an approval |
BUG | The work item is a bug |
DEFAULT_TASK | The work item is a default task |
EPIC | The work item is an epic |
INCIDENT | The work item is an incident |
ISSUE | The work item is an issue |
MILESTONE | The work item is a milestone |
OTHER | The work item is other |
PROBLEM | The work item is a problem |
QUESTION | The work item is a question |
SECTION | The work item is a section |
STORY | The work item is a story |
TASK | The work item is a task |
WORK_ITEM | The work item is a work item |
Rate this page: