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 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.
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 database.
| Field | Type | Description |
|---|---|---|
author | User | Original user who created this database. |
databaseId | ID! | Content-specific identifier for the database within Confluence. This is distinct from the ARI and used for internal content management. |
id | ID! | Unique identifier for the Confluence database. This ID is globally unique across the entire Teamwork Graph. Format: ConfluenceDatabaseARI |
lastEditor | User | User who most recently modified this database. This could include changes to data, structure, or configuration. |
lastUpdatedAt | DateTime | Timestamp of the most recent modification to the database content, structure, or metadata. |
owner | User | User designated as the owner of this database. The owner typically has administrative control over the database structure and permissions. |
status | ConfluenceContentStatus | Current publication status of the database, indicating its lifecycle state and visibility. |
title | String | Display title of the database as shown in the UI and navigation. |
| 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 database:
Relationships where Confluence database is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user contributed to Confluence database | Atlassian user | Confluence database |
| Atlassian user favorited Confluence database | Atlassian user | Confluence database |
| Confluence page has Confluence database | Confluence page | Confluence database |
| Confluence space has Confluence database | Confluence space | Confluence database |
| Atlassian user created Confluence database | Atlassian user | Confluence database |
Rate this page: