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 Jan 8, 2026

Confluence folder

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 folder in Confluence for organizing and grouping related content. Folders provide hierarchical structure and navigation within Confluence spaces, allowing teams to organize pages, blog posts, and other content into logical groupings.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

  • Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
  • Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Confluence folder.

FieldTypeDescription
authorUserOriginal User who authored the Folder.
folderIdID!Content ID of the Folder.
idID!Unique identifier for the Confluence folder. This ID is globally unique across the entire Teamwork Graph.
lastEditorUserUser who last edited this Folder.
lastUpdatedAtDateTimeTimestamp of the most recent modification to the Folder content or metadata.
ownerUserThe owner of the Folder.
sourceTemplateEntityIdIDBlueprint templateEntityId associated with the Content.
spaceConfluenceSpaceSpace that contains the Folder.
statusConfluenceContentStatusStatus of the Folder.
titleStringTitle of the Folder.
typeConfluenceContentTypeContent type of the Folder. Will always be \"FOLDER\".

Fields for ConfluenceSpace

FieldTypeDescription
aliasStringAlternative identifier or short name for the space. Provides additional flexibility in referencing and organizing spaces.
createdAtDateTimeTimestamp when the space was originally created.
creatorUserUser who originally created this space.
descriptionStringDescriptive text explaining the purpose and scope of the space. Helps users understand the space's content and intended use.
idID!Unique identifier for the Confluence space. This ID is globally unique across the entire Teamwork Graph. Format: ConfluenceSpaceARI
keyStringShort, 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").
nameStringDisplay name of the space as shown in the UI and navigation. This is the primary human-readable identifier for the space.
statusConfluenceSpaceStatusCurrent lifecycle status of the space. Indicates whether the space is active (CURRENT) or has been archived (ARCHIVED).
typeConfluenceSpaceTypeClassification of the space's scope and ownership. GLOBAL spaces are shared team spaces, while PERSONAL spaces belong to individual users.
webUrlURLLinks associated with the Space.

Values for ConfluenceSpaceStatus

ValueDescription
ARCHIVEDSpace 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.
CURRENTSpace is currently active and in normal use. This is the default state for spaces that are actively being used for collaboration.

Values for ConfluenceSpaceType

ValueDescription
GLOBALShared team space accessible to multiple users. Global spaces are used for team collaboration, documentation, and shared knowledge. Access is typically controlled through space permissions.
PERSONALPersonal 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.

Values for ConfluenceContentStatus

ValueDescription
ARCHIVEDContent 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.
CURRENTContent is currently published and visible. This is the normal state for live content that users can view and interact with.
DELETEDContent has been permanently deleted. Deleted content is typically not recoverable through normal user actions. May be retained for audit or compliance purposes.
DRAFTContent 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.
HISTORICALContent represents a historical version. Historical versions preserve content evolution and enable version comparison. Not directly visible but accessible through version history.
TRASHEDContent 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.

Values for ConfluenceContentType

ValueDescription
ATTACHMENTThe content is an attachment
BLOG_POSTThe content is a blog post
COMMENTThe content is a comment
DATABASEThe content is a database
EMBEDThe content is an embed
FOLDERThe content is a folder
PAGEThe content is a page
WHITEBOARDThe content is a whiteboard

Available relationships

The following relationships are currently supported for Confluence folder:

Relationships where Confluence folder is the target object.

Relationship nameFrom object typeTo object type
Confluence space has Confluence folderConfluence spaceConfluence folder
Atlassian user has Confluence meeting notes folderAtlassian userConfluence folder

Rate this page: