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 unless you have an approved path to production.
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 video from an external or third-party system integrated with the Teamwork Graph.
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 External video.
| Field | Type | Description |
|---|---|---|
chapters | [ExternalChapter] | Chapters within the video. |
commentCount | Int | Number of comments on the video. |
contributors | [ExternalContributor] | Contributors to the video. |
createdAt | DateTime | Timestamp when the video was created. |
createdBy | User | User who created this video. |
description | String | Description of the video. |
displayName | String | Display name of the video as shown in the source system. |
durationInSeconds | Int | Duration of the video in seconds. |
embedUrl | URL | URL for embedding the video. |
externalId | ID | Identifier of the video in the external system. |
height | Int | Height of the video in pixels. |
id | ID! | Unique identifier for the video. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the video. |
lastUpdatedBy | User | User who last updated this video. |
owners | [User] | Users who own this video. |
provider | ExternalProvider | Provider or integration that supplies this video. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
thumbnailUrl | URL | URL of the video's thumbnail image. |
url | URL | Direct URL to view the video in its source system. |
width | Int | Width of the video in pixels. |
| Field | Type | Description |
|---|---|---|
startTimeInSeconds | Int | Start time of the chapter in seconds. |
title | String | Title of the chapter. |
| Field | Type | Description |
|---|---|---|
interactionCount | Int | Number of interactions by this contributor. |
user | User | The contributing user. |
| 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"). |
The following relationships are currently supported for External video:
Relationships where External video is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user updated documents | Atlassian user | External video |
| Atlassian user viewed documents | Atlassian user | External video |
| External calendar event links external video | External calendar event | External video |
Rate this page: