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 Feb 23, 2026

External remote link

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 remote link from an external system integrated with the Teamwork Graph. Remote links connect Atlassian entities (such as Jira issues) to external resources, providing visibility into related items across different tools and systems.

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 remote link.

FieldTypeDescription
actionIds[String]List of action identifiers available for this remote link.
assigneeUserUser assigned to this remote link.
attributeMap[ExternalRemoteLinkAttributeTuple]Key-value attribute map containing additional metadata for this remote link.
authorUserUser who authored this remote link.
categoryStringCategory or classification of the remote link.
createdAtDateTimeTimestamp when the remote link was created.
creatorUserUser who created this remote link.
descriptionStringDescription of the remote link.
displayNameStringDisplay name of the remote link as shown in the source system.
idID!Unique identifier for the remote link. This ID is globally unique across the entire Teamwork Graph.
lastEditorUserUser who last updated this remote link.
providerExternalProviderProvider or integration that supplies this remote link.
remoteLinkIdStringIdentifier of the remote link in the external system.
statusStringCurrent status label of the remote link.
typeStringType or classification of the remote link.
updatedAtDateTimeTimestamp of the most recent update to the remote link.
urlURLDirect URL to view the remote link target in its source system.

Fields for ExternalRemoteLinkAttributeTuple

FieldTypeDescription
keyStringThe attribute key.
valueStringThe attribute value.

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 remote link:

Relationships where External remote link is the target object.

Relationship nameFrom object typeTo object type
Atlassian user updated documentsAtlassian userExternal remote link
Atlassian user viewed documentsAtlassian userExternal remote link

Rate this page: