Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jul 24, 2026

External pull request

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

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for External pull request.

FieldTypeDescription
authorUserUser who authored the pull request.
commentCountIntNumber of comments on the pull request.
containerIdIDIdentifier of the container (e.g., repository) that holds this pull request.
createdAtDateTimeTimestamp when the pull request was created.
createdByUserUser who created this pull request.
descriptionStringDescription of the pull request.
displayIdIDDisplay identifier for the pull request (e.g., PR number).
displayNameStringDisplay name or title of the pull request.
idID!Unique identifier for the pull request. This ID is globally unique across the entire Teamwork Graph.
lastUpdatedAtDateTimeTimestamp of the most recent update to the pull request.
lastUpdatedByUserUser who last updated this pull request.
providerExternalProviderProvider or integration that supplies this pull request.
pullRequestIdIDIdentifier of the pull request in the external system.
repositoryIdIDIdentifier of the repository containing this pull request.
reviewers[ExternalReviewer]Reviewers requested for this pull request.
statusExternalPullRequestStatusCurrent status of the pull request.
supportedActions[String]List of actions that can be performed on this pull request.
tasksCountIntNumber of tasks associated with the pull request.
thirdPartyIdIDAdditional identifier used by the third-party system.
titleStringTitle of the pull request.
urlURLDirect URL to view the pull request in its source system.

Fields for ExternalProvider

FieldTypeDescription
idID!Unique identifier for the external provider.
logoUrlURLURL to the provider's logo image for UI display.
nameStringDisplay name of the provider (e.g., "Google Drive", "Dropbox", "GitHub").

Fields for ExternalReviewer

FieldTypeDescription
approvalStatusExternalApprovalStatusThe current approval status of the reviewer for the pull request. Indicates whether the reviewer has approved, requested changes, or has not yet reviewed.
userUserThe 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

ValueDescription
APPROVEDThe reviewer has approved the pull request. Indicates the changes are acceptable and ready to be merged.
NEEDSWORKThe reviewer has requested changes to the pull request. Indicates the code needs modifications before it can be approved.
UNAPPROVEDThe reviewer has not yet provided an approval decision. This is the default state when a reviewer is first assigned.

Values for ExternalPullRequestStatus

ValueDescription
DECLINEDThe pull request is declined
DRAFTThe pull request is a draft
MERGEDThe pull request is merged
OPENThe pull request is open
UNKNOWNThe pull request status is unknown

Available relationships

The following relationships are currently supported for External pull request:

Relationships where External pull request is the source object.

Relationship nameFrom object typeTo object type
Content entity links entityExternal pull requestCompass 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 entityExternal pull request>> COULD NOT FIND
External pull request has external commentExternal pull requestExternal comment
External pull request has external commitExternal pull requestExternal commit
External pull request links external serviceExternal pull requestExternal Service

Rate this page: