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.
Object types represent different categories of data in Teamwork Graph. When you query the Teamwork Graph API, you work with object types to access and traverse objects and their relationships.
Each object type defines a standardized structure for objects in the graph, including their properties, relationships, and how they can be queried. Objects are identified using Atlassian Resource Identifiers (ARIs), which provide globally unique identifiers for objects across Atlassian.
The following object types are currently available in the Teamwork Graph API (EAP):
| Object type | Description |
|---|---|
| Atlassian goal | Represents a goal in Atlassian's team directory and goal-tracking platform. |
| Atlassian goal update | Represents an update or progress report for an Atlassian goal. |
| Atlassian Home comment | Represents a comment made within Atlassian on goals, projects, or updates. |
| Atlassian Home tag | Represents a tag in Atlassian used to organize and categorize goals and projects. |
| Atlassian project | Represents a project in Atlassian, grouping related work and team activities. |
| Atlassian project update | Represents a status update or progress report for an Atlassian project. |
| Atlassian user | Represents a user with an Atlassian account. |
| Object type | Description |
|---|---|
| Compass component | Represents a software component tracked in Compass, Atlassian's developer experience platform. |
| Compass component link | Represents a link to an entity or resource on the internet associated with a Compass component. |
| Compass scorecard | Represents a scorecard in Compass that evaluates component health and best practices. |
| Object type | Description |
|---|---|
| Confluence blog post | Represents a Confluence blog post - a time-ordered publication within a Confluence space. |
| Confluence comment | Represents a comment on Confluence content for collaboration and feedback. |
| Confluence database | Represents a Confluence database for structured data management and organization. |
| Confluence embed | Represents an embedded content item in Confluence such as third-party integrations or media. |
| Confluence folder | Represents a folder in Confluence for organizing and grouping related content. |
| Confluence page | Represents a Confluence page - a structured document within a Confluence space. |
| Confluence space | Represents a Confluence space - a container for organizing related content and collaboration. |
| Confluence whiteboard | Represents a Confluence whiteboard for visual collaboration and brainstorming. |
| Object type | Description |
|---|---|
| External branch | Represents a code branch from Bitbucket or an external version control system. |
| External build | Represents a build or deployment from Bitbucket or an external CI/CD system. |
| External calendar event | Represents a calendar event from an external scheduling or calendar system. |
| External comment | Represents a comment from an external system integrated with the Teamwork Graph. |
| External commit | Represents a code commit from Bitbucket or an external version control system. |
| External conversation | Represents a conversation or discussion thread from an external communication platform. |
| External customer org | Represents a customer organization from an external CRM or business system. |
| External dashboard | Represents a dashboard from an external analytics or reporting system. |
| External data table | Represents a data table from an external database or data management system. |
| External deal | Represents a business deal or sales opportunity from an external CRM system. |
| External deployment | Represents a deployment from an external CI/CD or deployment system. |
| External design | Represents a design artifact from an external design or creative tool. |
| External document | Represents a document from an external or third-party system integrated with the Teamwork Graph. |
| External feature flag | Represents a feature flag from an external feature management system. |
| External messages | Represents individual messages from external communication or messaging systems. |
| External organisation | Represents an organization from an external business or directory system. |
| External position | Represents a job position or role from an external HR or recruitment system. |
| External pull request | Represents a pull request from Bitbucket or an external version control system. |
| External repository | Represents a code repository from Bitbucket or an external version control system. |
| External Service | An External Service is a managed solution or component within the DevOps ecosystem that automates and streamlines software development, deployment, and operational processes |
| External vulnerability | Represents a security vulnerability from an external security scanning or monitoring system. |
| External work item | Represents a work item from an external project management or task tracking system. |
| External worker | Represents a worker or employee from an external HR or workforce management system. |
| Third party user | Represents a user from an external or third-party system integrated with the Teamwork Graph. |
| Object type | Description |
|---|---|
| Identity group | Represents a group in the Atlassian Identity system. |
| Opsgenie team | Represents a team in Opsgenie, Atlassian's incident response platform. |
| Team | Represents a team within an organization. |
| Object type | Description |
|---|---|
| Jira board | Represents a Jira board used for visualizing and managing work in Scrum or Kanban workflows. |
| Jira space | Represents a Jira Space (formerly called Project). |
| Jira sprint | Represents a sprint in Jira - a fixed time period during which specific work is completed. |
| Jira version | Represents a version or release in Jira used for tracking deliverables and milestones. |
| Jira work item | Represents a work item from Jira (issue, task, story, bug, etc. |
| Jira work item comment | Represents a comment on a Jira work item for collaboration and communication. |
| Jira work item priority | Represents the priority level assigned to a Jira work item for work prioritization. |
| Jira work item status | Represents the status of a Jira work item indicating its current state in the workflow. |
| Jira worklog | Represents time logging entries in Jira for tracking work effort on issues. |
| Object type | Description |
|---|---|
| Loom video | Represents a video from Loom, the video messaging and screen recording platform. |
Rate this page: