Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Represents a code branch from Bitbucket or an external version control system.

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

Cypher query properties

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

Fields for ExternalProvider

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").

Available relationships

The following relationships are currently supported for External branch:

From relationships

To relationships

Relationships where External branch is the source object.

Relationship name	From object type	To object type
Content entity links entity	External branch	Compass component Compass component link Compass scorecard Confluence blog post Confluence comment Confluence database Confluence embed Confluence page Confluence space Confluence whiteboard External customer contact External customer org category External organisation External position External work item External worker External branch External build External calendar event External comment External commit External conversation External customer org External dashboard External data table External deal External deployment External design External document External feature flag External messages External project External pull request External remote link External repository External Service External space External video External vulnerability Atlassian team Atlassian team custom field value Atlassian team type Atlassian user Jira board Jira work item Jira work item comment Jira work item priority Jira work item remote link Jira work item status Jira space Jira sprint Jira version Jira worklog Loom comment Loom meeting Loom meeting recurrence Loom space Loom video Focus change proposal Focus focus area Opsgenie team Atlassian Home comment Atlassian goal Atlassian goal update Atlassian project Atlassian project update Atlassian Home tag
External branch has external commit	External branch	External commit
External entity is third party entity	External branch	>> COULD NOT FIND