Developer
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 Jan 8, 2026

External deal

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

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

FieldTypeDescription
accountNameStringName of the account associated with this deal.
contactUserPrimary contact person for this deal.
createdAtDateTimeTimestamp when the deal was created.
createdByUserUser who created this deal.
dealClosedAtDateTimeTimestamp when the deal was closed.
descriptionStringDescription of the deal.
displayNameStringDisplay name of the deal.
externalIdIDIdentifier of the deal in the external system.
idID!Unique identifier for the deal. This ID is globally unique across the entire Teamwork Graph.
isClosedBooleanIndicates whether the deal has been closed (won or lost).
lastUpdatedAtDateTimeTimestamp of the most recent update to the deal.
lastUpdatedByUserUser who last updated this deal.
parentIdIDIdentifier of the parent deal or opportunity, if applicable.
providerExternalProviderProvider or integration that supplies this deal.
stageStringCurrent stage of the deal in the sales pipeline (e.g., "QUALIFICATION", "PROPOSAL", "NEGOTIATION").
statusStringCurrent status of the deal (e.g., "OPEN", "WON", "LOST").
thirdPartyIdIDAdditional identifier used by the third-party system.
urlURLDirect URL to view the deal 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").

Rate this page: