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.
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 remote link.
| Field | Type | Description |
|---|---|---|
actionIds | [String] | List of action identifiers available for this remote link. |
assignee | User | User assigned to this remote link. |
attributeMap | [ExternalRemoteLinkAttributeTuple] | Key-value attribute map containing additional metadata for this remote link. |
author | User | User who authored this remote link. |
category | String | Category or classification of the remote link. |
createdAt | DateTime | Timestamp when the remote link was created. |
creator | User | User who created this remote link. |
description | String | Description of the remote link. |
displayName | String | Display name of the remote link as shown in the source system. |
id | ID! | Unique identifier for the remote link. This ID is globally unique across the entire Teamwork Graph. |
lastEditor | User | User who last updated this remote link. |
provider | ExternalProvider | Provider or integration that supplies this remote link. |
remoteLinkId | String | Identifier of the remote link in the external system. |
status | String | Current status label of the remote link. |
type | String | Type or classification of the remote link. |
updatedAt | DateTime | Timestamp of the most recent update to the remote link. |
url | URL | Direct URL to view the remote link target in its source system. |
| Field | Type | Description |
|---|---|---|
key | String | The attribute key. |
value | String | The attribute value. |
| 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 remote link:
Relationships where External remote link is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user updated documents | Atlassian user | External remote link |
| Atlassian user viewed documents | Atlassian user | External remote link |
Rate this page: