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 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.
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 comment.
| Field | Type | Description |
|---|---|---|
author | User | Original user who created this Comment. |
bodyStorageValue | String | Body Value of the Comment. |
id | ID! | Unique identifier for the Confluence comment. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User who most recently modified this Comment. |
lastUpdatedAt | DateTime | Timestamp of the most recent modification to the Comment content, structure, or metadata. |
name | String | Title of the Comment. |
status | ConfluenceCommentStatus | Status of the Comment. |
webUrl | URL | Web URL associated with the Comment. |
| Value | Description |
|---|---|
CURRENT | The comment is current |
DRAFT | The comment is a draft |
The following relationships are currently supported for Confluence comment:
Relationships where Confluence comment is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Confluence comment has child Confluence comment | Confluence comment | Confluence comment |
Rate this page: