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 customer organization from an external CRM or business 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 customer org.
| Field | Type | Description |
|---|---|---|
accountType | String | Type of account (e.g., "ENTERPRISE", "SMB", "TRIAL"). |
country | String | Country where the customer organization is located. |
createdAt | DateTime | Timestamp when the customer organization was created. |
createdBy | User | User who created this customer organization. |
description | String | Description of the customer organization. |
displayName | String | Display name of the customer organization. |
externalId | ID | Identifier of the customer organization in the external system. |
id | ID! | Unique identifier for the customer organization. This ID is globally unique across the entire Teamwork Graph. |
industry | String | Industry or sector of the customer organization. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the customer organization. |
lastUpdatedBy | User | User who last updated this customer organization. |
parentId | ID | Identifier of the parent organization, if applicable. |
provider | ExternalProvider | Provider or integration that supplies this customer organization. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the customer organization 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: