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.
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.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Confluence whiteboard.
| Field | Type | Description |
|---|---|---|
author | User | Original User who authored the Whiteboard. |
bodyRepresentation | ConfluenceBodyRepresentation | Body Representation of the Whiteboard. |
bodyValue | String | Body Value of the Whiteboard. |
commentCountSummary | Int | Summary count of comments on the whiteboard. |
id | ID! | Unique identifier for the Confluence whiteboard. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User who last edited this whiteboard. |
lastUpdatedAt | DateTime | Timestamp of the most recent modification to the whiteboard content or metadata. |
owner | User | The owner of the Whiteboard. |
space | ConfluenceSpace | Space that contains the Whiteboard. |
status | ConfluenceContentStatus | Status of the Whiteboard. |
title | String | Title of the Whiteboard. |
type | ConfluenceContentType | Content type of the Whiteboard. Will always be \"WHITEBOARD\". |
whiteboardId | ID! | Content ID of the Whiteboard. |
| Field | Type | Description |
|---|---|---|
alias | String | Alternative identifier or short name for the space. Provides additional flexibility in referencing and organizing spaces. |
createdAt | DateTime | Timestamp when the space was originally created. |
creator | User | User who originally created this space. |
description | String | Descriptive text explaining the purpose and scope of the space. Helps users understand the space's content and intended use. |
id | ID! | Unique identifier for the Confluence space. This ID is globally unique across the entire Teamwork Graph. Format: ConfluenceSpaceARI |
key | String | Short, URL-friendly key that uniquely identifies the space within a Confluence instance. Used in URLs and as a human-readable identifier (e.g., "TEAM" or "DOCS"). |
name | String | Display name of the space as shown in the UI and navigation. This is the primary human-readable identifier for the space. |
status | ConfluenceSpaceStatus | Current lifecycle status of the space. Indicates whether the space is active (CURRENT) or has been archived (ARCHIVED). |
type | ConfluenceSpaceType | Classification of the space's scope and ownership. GLOBAL spaces are shared team spaces, while PERSONAL spaces belong to individual users. |
webUrl | URL | Links associated with the Space. |
| Value | Description |
|---|---|
ARCHIVED | Space has been archived and is no longer actively used. Archived spaces are preserved but hidden from normal navigation. Content remains accessible but the space is marked as inactive. |
CURRENT | Space is currently active and in normal use. This is the default state for spaces that are actively being used for collaboration. |
| Value | Description |
|---|---|
GLOBAL | Shared team space accessible to multiple users. Global spaces are used for team collaboration, documentation, and shared knowledge. Access is typically controlled through space permissions. |
PERSONAL | Personal space owned by an individual user. Personal spaces provide private areas for individual work, notes, and drafts. Typically visible only to the owner and explicitly granted users. |
| Value | Description |
|---|---|
ANONYMOUS_EXPORT_VIEW | Anonymous export view format |
ATLAS_DOC_FORMAT | Atlas document format |
DYNAMIC | Dynamic format |
EDITOR | Editor format |
EDITOR2 | Editor 2 format |
EXPORT_VIEW | Export view format |
STORAGE | Storage format |
STYLED_VIEW | Styled view format |
VIEW | View format |
WHITEBOARD_DOC_FORMAT | Whiteboard document format |
| Value | Description |
|---|---|
ARCHIVED | Content has been archived for long-term storage. Archived content is preserved but removed from normal navigation and search. Can be restored to CURRENT status if needed. |
CURRENT | Content is currently published and visible. This is the normal state for live content that users can view and interact with. |
DELETED | Content has been permanently deleted. Deleted content is typically not recoverable through normal user actions. May be retained for audit or compliance purposes. |
DRAFT | Content is in draft state and not yet published. Draft content is only visible to its author and authorized collaborators. Can be published by changing status to CURRENT. |
HISTORICAL | Content represents a historical version. Historical versions preserve content evolution and enable version comparison. Not directly visible but accessible through version history. |
TRASHED | Content has been moved to trash but not permanently deleted. Trashed content can typically be restored or permanently deleted. Provides a safety net before permanent deletion. |
| Value | Description |
|---|---|
ATTACHMENT | The content is an attachment |
BLOG_POST | The content is a blog post |
COMMENT | The content is a comment |
DATABASE | The content is a database |
EMBED | The content is an embed |
FOLDER | The content is a folder |
PAGE | The content is a page |
WHITEBOARD | The content is a whiteboard |
The following relationships are currently supported for Confluence whiteboard:
Relationships where Confluence whiteboard is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Confluence space has Confluence whiteboard | Confluence space | Confluence whiteboard |
| Atlassian user created Confluence whiteboard | Atlassian user | Confluence whiteboard |
| Atlassian user favorited Confluence whiteboard | Atlassian user | Confluence whiteboard |
| Jira work item links Confluence whiteboard | Jira work item | Confluence whiteboard |
| Jira sprint has retro Confluence whiteboard | Jira sprint | Confluence whiteboard |
| Atlassian user contributed to Confluence whiteboard | Atlassian user | Confluence whiteboard |
| Atlassian user watches Confluence whiteboard | Atlassian user | Confluence whiteboard |
| Atlassian user updated Confluence whiteboard | Atlassian user | Confluence whiteboard |
Rate this page: