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 code branch 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 branch.
| Field | Type | Description |
|---|---|---|
branchId | ID | Identifier of the branch in the external system. |
containerId | ID | Identifier of the container (e.g., repository) that holds this branch. |
createPullRequestUrl | URL | URL to create a pull request from this branch. |
createdAt | DateTime | Timestamp when the branch was created. |
createdBy | User | User who created this branch. |
displayName | String | Display name of the branch. |
id | ID! | Unique identifier for the branch. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the branch. |
lastUpdatedBy | User | User who last updated this branch. |
name | String | Name of the branch. |
provider | ExternalProvider | Provider or integration that supplies this branch. |
repositoryId | ID | Identifier of the repository containing this branch. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the branch 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"). |
The following relationships are currently supported for External branch:
Relationships where External branch is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| External repository has external branch | External branch | External repository |
Rate this page: