Developer
News and Updates
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 Apr 1, 2026

External video

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.

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 External video.

FieldTypeDescription
chapters[ExternalChapter]Chapters within the video.
commentCountIntNumber of comments on the video.
contributors[ExternalContributor]Contributors to the video.
createdAtDateTimeTimestamp when the video was created.
createdByUserUser who created this video.
descriptionStringDescription of the video.
displayNameStringDisplay name of the video as shown in the source system.
durationInSecondsIntDuration of the video in seconds.
embedUrlURLURL for embedding the video.
externalIdIDIdentifier of the video in the external system.
heightIntHeight of the video in pixels.
idID!Unique identifier for the video. This ID is globally unique across the entire Teamwork Graph.
lastUpdatedAtDateTimeTimestamp of the most recent update to the video.
lastUpdatedByUserUser who last updated this video.
owners[User]Users who own this video.
providerExternalProviderProvider or integration that supplies this video.
thirdPartyIdIDAdditional identifier used by the third-party system.
thumbnailUrlURLURL of the video's thumbnail image.
urlURLDirect URL to view the video in its source system.
widthIntWidth of the video in pixels.

Fields for ExternalChapter

FieldTypeDescription
startTimeInSecondsIntStart time of the chapter in seconds.
titleStringTitle of the chapter.

Fields for ExternalContributor

FieldTypeDescription
interactionCountIntNumber of interactions by this contributor.
userUserThe contributing user.

Fields for ExternalProvider

FieldTypeDescription
idID!Unique identifier for the external provider.
logoUrlURLURL to the provider's logo image for UI display.
nameStringDisplay name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Available relationships

The following relationships are currently supported for External video:

Relationships where External video is the target object.

Rate this page: