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.
The Teamwork Graph API will provide access to a range of relationship types that connect objects across Atlassian apps and connected external tools. These relationships will enable you to traverse and analyze the connections between users, projects, issues, content, and other objects.
This documentation provides early insight into the relationship types that are planned for the API, helping you understand the potential connections and use cases that will be supported. Note that these relationship types are subject to change before and during the EAP. You may also notice inconsistencies in naming conventions and terminology, which we are working to resolve.
All relationships are categorized into three main types:
| Category | Description | Examples |
|---|---|---|
| Canonical | Direct, structural connections between objects. These are the primary relationships that define ownership, containment, and logical associations. |
|
| Activity | User actions and interactions with objects. These relationships capture behavioral data and change events. |
|
When available, all relationships will be queryable using both Cypher and GraphQL. See the individual relationship documentation pages for specific GraphQL and Cypher query examples.
Many relationships include additional metadata that provides context about the connection:
Rate this page: