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 unless you have an approved path to production.
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 provides 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.
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.
The following tables list all available relationship types, organized by category.
| Relationship name | To object type |
|---|---|
| Atlassian home tag is alias of Atlassian home tag | Atlassian Home tag |
| 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 |
|---|---|
| Document has comments | Confluence comment |
| Relationship name | To object type |
|---|---|
| Entity links entity | Confluence blog post Confluence page |
| Relationship name | To object type |
|---|---|
| External calendar has linked external document | External document |
| Relationship name | To object type |
|---|---|
| External conversation has external message | External messages |
| External conversation mentions Jira work item | Jira work item |
| 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 |
| External message mentions Jira work item | Jira work item |
| 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 position manages external org | External organisation |
| External position manages external position | External position |
| Relationship name | To object type |
|---|---|
| External worker fills external position | External position |
| Relationship name | To object type |
|---|---|
| Focus focus area has Atlassian goal | Atlassian goal |
| Focus focus area has child Focus focus area | Focus focus area |
| Focus focus area has Confluence page | Confluence page |
| 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 space links knowledge base entity | Confluence space External document |
| Relationship name | To object type |
|---|---|
| Loom video has Confluence page | Confluence page |
| Loom video has Loom video comment | Loom comment |
| Loom video shared with Atlassian user | Atlassian user |
| Relationship name | To object type |
|---|---|
| Space has documents | Confluence blog post Confluence page Confluence whiteboard |
| Relationship name | To object type |
|---|---|
| Sprint has retro documents | Confluence page Confluence whiteboard |
Rate this page: