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 pull request 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 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.
`reviewers`	`[ExternalReviewer]`	Reviewers requested for 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.

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

Fields for ExternalReviewer

Field	Type	Description
`approvalStatus`	`ExternalApprovalStatus`	The current approval status of the reviewer for the pull request. Indicates whether the reviewer has approved, requested changes, or has not yet reviewed.
`user`	`User`	The user who is assigned as a reviewer for the pull request. Contains the reviewer's identity and profile information from the external system.

Values for ExternalApprovalStatus

Value	Description
`APPROVED`	The reviewer has approved the pull request. Indicates the changes are acceptable and ready to be merged.
`NEEDSWORK`	The reviewer has requested changes to the pull request. Indicates the code needs modifications before it can be approved.
`UNAPPROVED`	The reviewer has not yet provided an approval decision. This is the default state when a reviewer is first assigned.

Values for ExternalPullRequestStatus

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

Available relationships

The following relationships are currently supported for External pull request:

From relationships

To relationships

Relationships where External pull request is the source object.

Relationship name	From object type	To object type
Content entity links entity	External pull request	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 entity is third party entity	External pull request	>> COULD NOT FIND
External pull request has external comment	External pull request	External comment
External pull request has external commit	External pull request	External commit
External pull request links external service	External pull request	External Service