Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Nov 24, 2025

API object types

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):

Atlassian objects

Object typeDescription
Atlassian goalRepresents a goal in Atlassian's team directory and goal-tracking platform.
Atlassian goal updateRepresents an update or progress report for an Atlassian goal.
Atlassian Home commentRepresents a comment made within Atlassian on goals, projects, or updates.
Atlassian Home tagRepresents a tag in Atlassian used to organize and categorize goals and projects.
Atlassian projectRepresents a project in Atlassian, grouping related work and team activities.
Atlassian project updateRepresents a status update or progress report for an Atlassian project.
Atlassian userRepresents a user with an Atlassian account.

Compass and Opsgenie

Object typeDescription
Compass componentRepresents a software component tracked in Compass, Atlassian's developer experience platform.
Compass component linkRepresents a link to an entity or resource on the internet associated with a Compass component.
Compass scorecardRepresents a scorecard in Compass that evaluates component health and best practices.

Confluence objects

Object typeDescription
Confluence blog postRepresents a Confluence blog post - a time-ordered publication within a Confluence space.
Confluence commentRepresents a comment on Confluence content for collaboration and feedback.
Confluence databaseRepresents a Confluence database for structured data management and organization.
Confluence embedRepresents an embedded content item in Confluence such as third-party integrations or media.
Confluence folderRepresents a folder in Confluence for organizing and grouping related content.
Confluence pageRepresents a Confluence page - a structured document within a Confluence space.
Confluence spaceRepresents a Confluence space - a container for organizing related content and collaboration.
Confluence whiteboardRepresents a Confluence whiteboard for visual collaboration and brainstorming.

External objects

Object typeDescription
External branchRepresents a code branch from Bitbucket or an external version control system.
External buildRepresents a build or deployment from Bitbucket or an external CI/CD system.
External calendar eventRepresents a calendar event from an external scheduling or calendar system.
External commentRepresents a comment from an external system integrated with the Teamwork Graph.
External commitRepresents a code commit from Bitbucket or an external version control system.
External conversationRepresents a conversation or discussion thread from an external communication platform.
External customer orgRepresents a customer organization from an external CRM or business system.
External dashboardRepresents a dashboard from an external analytics or reporting system.
External data tableRepresents a data table from an external database or data management system.
External dealRepresents a business deal or sales opportunity from an external CRM system.
External deploymentRepresents a deployment from an external CI/CD or deployment system.
External designRepresents a design artifact from an external design or creative tool.
External documentRepresents a document from an external or third-party system integrated with the Teamwork Graph.
External feature flagRepresents a feature flag from an external feature management system.
External messagesRepresents individual messages from external communication or messaging systems.
External organisationRepresents an organization from an external business or directory system.
External positionRepresents a job position or role from an external HR or recruitment system.
External pull requestRepresents a pull request from Bitbucket or an external version control system.
External repositoryRepresents a code repository from Bitbucket or an external version control system.
External ServiceAn External Service is a managed solution or component within the DevOps ecosystem that automates and streamlines software development, deployment, and operational processes
External vulnerabilityRepresents a security vulnerability from an external security scanning or monitoring system.
External work itemRepresents a work item from an external project management or task tracking system.
External workerRepresents a worker or employee from an external HR or workforce management system.
Third party userRepresents a user from an external or third-party system integrated with the Teamwork Graph.

Identity and teams

Object typeDescription
Identity groupRepresents a group in the Atlassian Identity system.
Opsgenie teamRepresents a team in Opsgenie, Atlassian's incident response platform.
TeamRepresents a team within an organization.

Jira objects

Object typeDescription
Jira boardRepresents a Jira board used for visualizing and managing work in Scrum or Kanban workflows.
Jira spaceRepresents a Jira Space (formerly called Project).
Jira sprintRepresents a sprint in Jira - a fixed time period during which specific work is completed.
Jira versionRepresents a version or release in Jira used for tracking deliverables and milestones.
Jira work itemRepresents a work item from Jira (issue, task, story, bug, etc.
Jira work item commentRepresents a comment on a Jira work item for collaboration and communication.
Jira work item priorityRepresents the priority level assigned to a Jira work item for work prioritization.
Jira work item statusRepresents the status of a Jira work item indicating its current state in the workflow.
Jira worklogRepresents time logging entries in Jira for tracking work effort on issues.

Other

Object typeDescription
Loom videoRepresents a video from Loom, the video messaging and screen recording platform.

Rate this page: