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 business deal or sales opportunity from an external CRM 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 deal.

Field	Type	Description
`accountName`	`String`	Name of the account associated with this deal.
`contact`	`User`	Primary contact person for this deal.
`createdAt`	`DateTime`	Timestamp when the deal was created.
`createdBy`	`User`	User who created this deal.
`dealClosedAt`	`DateTime`	Timestamp when the deal was closed.
`description`	`String`	Description of the deal.
`displayName`	`String`	Display name of the deal.
`externalId`	`ID`	Identifier of the deal in the external system.
`id`	`ID!`	Unique identifier for the deal. This ID is globally unique across the entire Teamwork Graph.
`isClosed`	`Boolean`	Indicates whether the deal has been closed (won or lost).
`lastUpdatedAt`	`DateTime`	Timestamp of the most recent update to the deal.
`lastUpdatedBy`	`User`	User who last updated this deal.
`parentId`	`ID`	Identifier of the parent deal or opportunity, if applicable.
`provider`	`ExternalProvider`	Provider or integration that supplies this deal.
`stage`	`String`	Current stage of the deal in the sales pipeline (e.g., "QUALIFICATION", "PROPOSAL", "NEGOTIATION").
`status`	`String`	Current status of the deal (e.g., "OPEN", "WON", "LOST").
`thirdPartyId`	`ID`	Additional identifier used by the third-party system.
`url`	`URL`	Direct URL to view the deal 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 deal:

To relationships

Relationships where External deal is the target object.

Relationship name	From object type	To object type
Atlassian user created deals	Atlassian user	External deal
Atlassian user owns deals	Atlassian user	External deal
Atlassian user updated deals	Atlassian user	External deal
Content entity links entity	Confluence blog post Confluence comment Confluence page Jira work item Jira work item comment External branch External build External calendar event External comment External commit External conversation External data table External deployment External design External document External messages External project External pull request External repository External video External vulnerability External work item	External deal
External video links external deal	External video	External deal