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.
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. Goals define objectives that teams or individuals work towards achieving. |
| Atlassian goal update | Represents an update or progress report for an Atlassian goal. Goal updates track progress, changes in status, or milestone achievements for specific goals. |
| Atlassian home comment | Represents a comment made within Atlassian on goals, projects, or updates. Atlassian Home comments enable team collaboration and discussion around shared objectives and project activities. |
| Atlassian home tag | Represents a tag in Atlassian used to organize and categorize goals and projects. Tags help teams discover and group related work across Atlassian. |
| Atlassian project | Represents a project in Atlassian, grouping related work and team activities. Projects provide structure for organizing goals, updates, and team collaboration within Atlassian. |
| Atlassian project update | Represents a status update or progress report for an Atlassian project. Project updates communicate progress, blockers, or changes in project status to team members and stakeholders. |
| Atlassian team | Represents a team within an organization. Teams are collections of users that work together on projects and initiatives. |
| Atlassian user | Represents a user with an Atlassian account. These are typically human users who have authenticated through Atlassian's identity system. |
| Object type | Description |
|---|---|
| Compass component | Represents a software component tracked in Compass, Atlassian's developer experience platform. Components define microservices, libraries, or other software artifacts with associated metadata, ownership, and health metrics. |
| 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. Scorecards define criteria and metrics to assess software quality, security, and operational excellence across components. |
| Object type | Description |
|---|---|
| Confluence blogpost | Represents a Confluence blog post - a time-ordered publication within a Confluence space. Blog posts are used for announcements, updates, team communications, and time-sensitive content that follows a chronological publishing pattern. |
| Confluence comment | Represents a comment on Confluence content for collaboration and feedback. Confluence comments enable discussions, reviews, and collaborative editing on pages, blog posts, and other content. They facilitate asynchronous communication and provide context-specific feedback directly on content. |
| Confluence database | Represents a Confluence database for structured data management and organization. Databases provide table-like functionality for managing structured information within Confluence spaces, enabling teams to track items, manage projects, and organize data in a structured format. |
| Confluence embed | Represents an embedded content item in Confluence such as third-party integrations or media. Embeds allow teams to incorporate external content and services directly into Confluence pages, providing seamless integration with other tools and platforms. |
| Confluence page | Represents a Confluence page - a structured document within a Confluence space. Pages are the primary content type in Confluence, used for documentation, knowledge sharing, collaboration, and information organization. |
| Confluence space | Represents a Confluence space - a container for organizing related content and collaboration. Spaces provide structure, permissions, and context for pages, blog posts, and other collaborative content. They serve as the top-level organizational unit in Confluence, grouping related work and defining access controls. |
| Confluence whiteboard | Represents a Confluence whiteboard for visual collaboration and brainstorming. Whiteboards provide infinite canvas spaces for diagramming, planning, and collaborative visual work. They enable teams to ideate, organize ideas, and create visual representations of complex concepts. |
| 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. Calendar events include meetings, appointments, or scheduled activities integrated from third-party calendar platforms. |
| 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. Conversations include chat threads, forum discussions, or communication channels from third-party messaging systems. |
| External deployment | Represents a deployment from an external CI/CD or deployment system. Deployments track the release of software changes to various environments. |
| External design | Represents a design artifact from an external design or creative tool. Designs include mockups, prototypes, wireframes, or visual assets integrated from third-party design platforms. |
| External document | Represents a document from an external or third-party system integrated with the Teamwork Graph. These documents originate from systems outside the core Atlassian product suite but are accessible through the unified graph interface. |
| External feature flag | Represents a feature flag from an external feature management system. Feature flags include toggles, experiments, or configuration flags integrated from third-party feature flagging platforms. |
| External message | 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 work items include tickets, tasks, or issues integrated from third-party project management platforms. |
| External worker | Represents a worker or employee from an external HR or workforce management system. |
| Object type | Description |
|---|---|
| Focus focus area | Represents a focus area from Mercury, aggregating status, metadata, and change summaries. |
| Object type | Description |
|---|---|
| Jira board | Represents a Jira board used for visualizing and managing work in Scrum or Kanban workflows. Boards provide visual interfaces for tracking issue progress and team workflow management. |
| Jira space | Represents a Jira Space (formerly called Project). Spaces organize work items, define workflows, and manage team collaboration within Jira. |
| 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.). Extends the base WorkItem interface with Jira-specific fields for user assignments. |
| 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. Priorities help teams understand the relative importance and urgency of different work items. |
| Jira work item status | Represents the status of a Jira work item indicating its current state in the workflow. Work item statuses track work progress through defined states like "To Do", "In Progress", or "Done". |
| Jira work item worklog | Represents time logging entries in Jira for tracking work effort on issues. |
| Object type | Description |
|---|---|
| Loom comment | Represents a comment from Loom video, the video messaging and screen recording platform. |
| Loom video | Represents a video from Loom, the video messaging and screen recording platform. |
| Object type | Description |
|---|---|
| Opsgenie team | Represents a team in Opsgenie, Atlassian's incident response platform. Teams define groups of responders responsible for handling incidents and alerts in Opsgenie. |
Rate this page: