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.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
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. |
| 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"). |
Rate this page: