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

External 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 an external project management or task tracking system. External work items include tickets, tasks, or issues integrated from third-party project management platforms.

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 External work item.

FieldTypeDescription
assigneeUserUser assigned to work on this work item.
collaborators[User]List of users collaborating on this work item.
createdAtDateTimeTimestamp when the work item was created.
creatorUserUser who created this work item.
descriptionStringDescription or detailed information about the work item.
displayNameStringDisplay name or title of the work item.
dueAtDateTimeDue date for when the work item should be completed.
exceedsMaxCollaboratorsBooleanIndicates whether the number of collaborators exceeds the maximum display limit.
externalIdIDIdentifier of the work item in the external system.
idID!Unique identifier for the work item. This ID is globally unique across the entire Teamwork Graph.
lastEditorUserUser who last edited this work item.
lastUpdatedAtDateTimeTimestamp of the most recent update to the work item.
providerExternalProviderProvider or integration that supplies this work item.
statusStringCurrent status of the work item (e.g., "OPEN", "IN_PROGRESS", "COMPLETED").
subtypeExternalWorkItemSubtypeSubtype or classification of the work item.
teamStringTeam or group responsible for this work item.
urlURLDirect URL to view the work item in its source system.
workItemProjectExternalWorkItemProjectProject that contains this work item.

Fields for ExternalProvider

FieldTypeDescription
idID!Unique identifier for the external provider.
logoUrlURLURL to the provider's logo image for UI display.
nameStringDisplay name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Fields for ExternalWorkItemProject

FieldTypeDescription
idID!Unique identifier for the project.
nameStringDisplay name of the project.

Values for ExternalWorkItemSubtype

ValueDescription
APPROVALThe work item is an approval
BUGThe work item is a bug
DEFAULT_TASKThe work item is a default task
EPICThe work item is an epic
INCIDENTThe work item is an incident
ISSUEThe work item is an issue
MILESTONEThe work item is a milestone
OTHERThe work item is other
PROBLEMThe work item is a problem
QUESTIONThe work item is a question
SECTIONThe work item is a section
STORYThe work item is a story
TASKThe work item is a task
WORK_ITEMThe work item is a work item

Rate this page: