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:
The following tables list all available relationship types, organized by category and source object type.
| Relationship name | To object type |
|---|---|
| Atlassian group can view Confluence space | Confluence space |
| Relationship name | To object type |
|---|---|
| Atlassian home tag is alias of Atlassian home tag | Atlassian Home tag |
| Relationship name | To object type |
|---|
| Relationship name | To object type |
|---|---|
| Compass component has Compass component link | Compass component link |
| Relationship name | To object type |
|---|---|
| Compass component link is Jira space | Jira space |
| Relationship name | To object type |
|---|---|
| Compass scorecard has Atlassian goal | Atlassian goal |
| Relationship name | To object type |
|---|---|
| Confluence blogpost has Confluence comment | Confluence comment |
| Confluence blogpost shared with Atlassian user | Atlassian user |
| Relationship name | To object type |
|---|---|
| Confluence comment has child Confluence comment | Confluence comment |
| Relationship name | To object type |
|---|---|
| Entity links entity | Confluence page |
| Entity links entity | Confluence blog post |
| Relationship name | To object type |
|---|---|
| Entity links entity | Confluence page |
| Entity links entity | Confluence blog post |
| Relationship name | To object type |
|---|---|
| External repository has external branch | External repository |
| Relationship name | To object type |
|---|---|
| External calendar has linked external document | External document |
| Relationship name | To object type |
|---|---|
| External pull request has external commit | External pull request |
| External repository has external commit | External repository |
| Relationship name | To object type |
|---|---|
| External conversation has external message | External messages |
| Relationship name | To object type |
|---|---|
| External document has child external document | External document |
| Relationship name | To object type |
|---|---|
| External message has child external message | External messages |
| Relationship name | To object type |
|---|---|
| External org has child external org | External organisation |
| External org has external position | External position |
| Relationship name | To object type |
|---|---|
| External conversation mentions Jira work item | External conversation |
| External message mentions Jira work item | External messages |
| Relationship name | To object type |
|---|---|
| Jira work item links external vulnerability | Jira work item |
| Relationship name | To object type |
|---|---|
| Jira space has Jira board | Jira space |
| Relationship name | To object type |
|---|---|
| Jira sprint has Jira work item | Jira work item |
| Jira sprint has retro Confluence page | Confluence page |
| Jira sprint has retro Confluence whiteboard | Confluence whiteboard |
| Relationship name | To object type |
|---|---|
| Jira version links external feature flag | External feature flag |
| Jira version links Jira work item | Jira work item |
| Relationship name | To object type |
|---|---|
| JSM incident impacts Compass component | Jira work item |
| Relationship name | To object type |
|---|---|
| JSM incident links external service | Jira work item |
| Relationship name | To object type |
|---|---|
| JSM space links knowledge base entity | External document |
| JSM space links knowledge base entity | Confluence space |
| Relationship name | To object type |
|---|---|
| JSM incident links Jira post incident review | Jira work item |
| JSM incident links Jira work item | Jira work item |
| JSM incident links JSM post incident review link | Jira work item |
| Relationship name | To object type |
|---|---|
| Loom video has Confluence page | Confluence page |
| Loom video shared with Atlassian user | Atlassian user |
Rate this page: