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 customer contact 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 contact.
| Field | Type | Description |
|---|---|---|
accountName | String | Name of the account associated with this customer contact. |
buyerAttributes | String | Buyer attributes associated with this customer contact. |
canAllowPortalSelfReg | Boolean | Indicates whether the customer contact can allow portal self-registration. |
cleanStatus | String | The status of the Data.com Clean match for that contact record Indicating whether the record has been matched and synchronized with Data.com data |
contactSource | String | Source of the customer contact (e.g., how the contact was acquired). |
contactUser | User | User associated with this customer contact. |
containerId | ID | Identifier of the container that holds this customer contact. |
createdAt | DateTime | Timestamp when the customer contact was created. |
createdBy | User | User who created this customer contact. |
customerType | String | Type of customer (e.g., "PROSPECT", "CUSTOMER", "PARTNER"). |
description | String | Description of the customer contact. |
displayName | String | Display name of the customer contact. |
emailBouncedAt | DateTime | Timestamp when the email bounced. |
emailBouncedReason | String | Reason for the email bounce. |
externalId | ID | Identifier of the customer contact in the external system. |
firstCallAt | DateTime | Timestamp of the first call with this customer contact. |
firstEmailAt | DateTime | Timestamp of the first email sent to this customer contact. |
hasOptedOutOfEmail | Boolean | Indicates whether this customer contact has opted out of email communications. |
hasOptedOutOfFax | Boolean | Indicates whether this customer contact has opted out of fax communications. |
id | ID! | Unique identifier for the customer contact. This ID is globally unique across the entire Teamwork Graph. |
isDoNotCall | Boolean | Indicates whether this customer contact should not be called. |
isEmailBounced | Boolean | Indicates whether the email for this customer contact has bounced. |
isPriorityRecord | Boolean | Indicates whether this is a priority record. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the customer contact. |
lastUpdatedBy | User | User who last updated this customer contact. |
lastViewedAt | DateTime | Timestamp when this customer contact was last viewed. |
leadSource | String | Source of the lead for this customer contact. |
owners | [User] | Users who own this customer contact. |
parentId | ID | Identifier of the parent record, if applicable. |
preferredLanguage | String | Preferred language of the customer contact. |
provider | ExternalProvider | Provider or integration that supplies this customer contact. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the customer contact 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: