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 document from an external or third-party system integrated with the Teamwork Graph. These documents originate from systems outside the core Atlassian product suite but are accessible through the unified graph interface.

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

Cypher query properties

Object type fields

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

Field	Type	Description
`author`	`User`	User associated with this document's creation.
`byteSize`	`Long`	Size of the document in bytes. Useful for storage management and determining download/processing requirements.
`collaborators`	`[User]`	A list of Users who are collaborators on the document
`content`	`ExternalDocumentContent`	Content of the third-party document, including format information and actual content data. Supports multiple content representations to accommodate different source systems.
`createdAt`	`DateTime`	Timestamp when the document was created or first imported into the Teamwork Graph.
`displayName`	`String`	Display name of the document as shown in the source system. This may differ from the title and is optimized for UI presentation.
`externalId`	`ID`	Identifier of the document in the external system. This is the native ID used by the third-party system to reference the document.
`id`	`ID!`	Unique identifier for the third-party document. This ID is globally unique across the entire Teamwork Graph.
`lastEditor`	`User`	User who last updated this document's metadata or content.
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the document or its metadata.
`owners`	`[User]`	A list of Users who own the document
`provider`	`ExternalProvider`	Identifier of the external provider or integration that supplies this document. Links the document to its source system or integration.
`thirdPartyId`	`ID`	Additional identifier used by the third-party system. Provides supplementary identification for systems that use multiple ID schemes.
`title`	`String`	Title of the document from the external system.
`type`	`String`	Type or classification of the document in the external system. Examples might include: "DOCUMENT", "SPREADSHEET", "PRESENTATION", "PDF", etc.
`url`	`URL`	Direct URL to access or view the document in its source system. Provides a way to navigate from the Teamwork Graph to the external document.

Fields for ExternalDocumentContent

Field	Type	Description
`binary`	`String`	Base64-encoded binary content for non-text documents.
`mimeType`	`String`	MIME type indicating the content format and how it should be processed. Examples: "text/plain", "application/pdf", "image/jpeg", "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
`text`	`String`	Plain text representation of the document content.

Fields for ExternalProvider

Field	Type	Description
`id`	`ID!`	Unique identifier for the external provider.
`logoUrl`	`URL`	URL to the provider's logo image for UI display.
`name`	`String`	Display name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Available relationships

The following relationships are currently supported for External document:

From relationships

To relationships

Relationships where External document is the source object.

Relationship name	From object type	To object type
External document has child external document	External document	External document