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. 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 pull request from Bitbucket or an external version control system.
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 pull request.
| Field | Type | Description |
|---|---|---|
author | User | User who authored the pull request. |
commentCount | Int | Number of comments on the pull request. |
containerId | ID | Identifier of the container (e.g., repository) that holds this pull request. |
createdAt | DateTime | Timestamp when the pull request was created. |
createdBy | User | User who created this pull request. |
description | String | Description of the pull request. |
displayId | ID | Display identifier for the pull request (e.g., PR number). |
displayName | String | Display name or title of the pull request. |
id | ID! | Unique identifier for the pull request. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the pull request. |
lastUpdatedBy | User | User who last updated this pull request. |
provider | ExternalProvider | Provider or integration that supplies this pull request. |
pullRequestId | ID | Identifier of the pull request in the external system. |
repositoryId | ID | Identifier of the repository containing this pull request. |
status | ExternalPullRequestStatus | Current status of the pull request. |
supportedActions | [String] | List of actions that can be performed on this pull request. |
tasksCount | Int | Number of tasks associated with the pull request. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
title | String | Title of the pull request. |
url | URL | Direct URL to view the pull request in its source system. |
| 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"). |
| Value | Description |
|---|---|
DECLINED | The pull request is declined |
DRAFT | The pull request is a draft |
MERGED | The pull request is merged |
OPEN | The pull request is open |
UNKNOWN | The pull request status is unknown |
The following relationships are currently supported for External pull request:
Relationships where External pull request is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| External repository has external pull request | External pull request | External repository |
| External pull request links external service | External pull request | External Service |
| External pull request has external comment | External pull request | External comment |
Rate this page: