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 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.
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 page.
| Field | Type | Description |
|---|---|---|
author | User | User who originally created this page. |
content | ConfluenceBodies | Content body of the page in various format representations. Confluence stores content in multiple formats to support different use cases and integrations. |
createdAt | DateTime | Timestamp when the page was originally created. |
editUrl | URL | The full edit URL for editing the page. Example: https://mysite.atlassian.net/wiki/pages/edit-v2/10000 |
id | ID! | Unique identifier for the Confluence page. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User who last edited this page. |
lastUpdatedAt | DateTime | Timestamp of the most recent modification to the page content or metadata. |
owner | User | User who owns this page. |
pageId | ID | Content ID of the Confluence page. |
space | ConfluenceSpace | The Confluence space that contains this page. |
status | ConfluenceContentStatus | Current publication status of the page, indicating its lifecycle state and visibility. |
title | String | Title of the Confluence page as displayed in the UI and page hierarchy. |
webUrl | URL | The full web UI URL for viewing the page. Example: https://mysite.atlassian.net/wiki/spaces/TEST/pages/10000/Page+Title |
| Field | Type | Description |
|---|---|---|
atlasDocFormat | ConfluenceBody | Content in ATLAS_DOC_FORMAT representation.
This format is optimized for modern Confluence editing and rendering experiences. It provides a structured document model that supports rich content types, collaborative editing features, and advanced layout capabilities. |
storage | ConfluenceBody | Content in STORAGE format representation.
This is Confluence's native storage format that preserves the complete content structure including macros, formatting, and metadata. It's the authoritative representation used for persistence and serves as the source of truth for content. |
| Field | Type | Description |
|---|---|---|
representation | String | Identifier for the content representation format. |
value | String | The actual content data in the format specified by the representation field. |
| Field | Type | Description |
|---|---|---|
representation | String | Identifier for the content representation format. |
value | String | The actual content data in the format specified by the representation field. |
| 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 |
|---|---|
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. |
The following relationships are currently supported for Confluence page:
Relationships where Confluence page is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Confluence page has Confluence database | Confluence page | Confluence database |
| Confluence page shared with Atlassian user | Confluence page | Atlassian user |
| Confluence page has Confluence comment | Confluence page | Confluence comment |
| Confluence page has child Confluence page | Confluence page | Confluence page |
| Entity links entity | Confluence page | Confluence page Confluence blog post |
| Confluence page shared with Atlassian group | Confluence page | Atlassian Group |
Rate this page: