Developer
News and Updates
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 Apr 16, 2026

External customer contact

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.

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 customer contact.

FieldTypeDescription
accountNameStringName of the account associated with this customer contact.
buyerAttributesStringBuyer attributes associated with this customer contact.
canAllowPortalSelfRegBooleanIndicates whether the customer contact can allow portal self-registration.
cleanStatusStringThe status of the Data.com Clean match for that contact record Indicating whether the record has been matched and synchronized with Data.com data
contactSourceStringSource of the customer contact (e.g., how the contact was acquired).
contactUserUserUser associated with this customer contact.
containerIdIDIdentifier of the container that holds this customer contact.
createdAtDateTimeTimestamp when the customer contact was created.
createdByUserUser who created this customer contact.
customerTypeStringType of customer (e.g., "PROSPECT", "CUSTOMER", "PARTNER").
descriptionStringDescription of the customer contact.
displayNameStringDisplay name of the customer contact.
emailBouncedAtDateTimeTimestamp when the email bounced.
emailBouncedReasonStringReason for the email bounce.
externalIdIDIdentifier of the customer contact in the external system.
firstCallAtDateTimeTimestamp of the first call with this customer contact.
firstEmailAtDateTimeTimestamp of the first email sent to this customer contact.
hasOptedOutOfEmailBooleanIndicates whether this customer contact has opted out of email communications.
hasOptedOutOfFaxBooleanIndicates whether this customer contact has opted out of fax communications.
idID!Unique identifier for the customer contact. This ID is globally unique across the entire Teamwork Graph.
isDoNotCallBooleanIndicates whether this customer contact should not be called.
isEmailBouncedBooleanIndicates whether the email for this customer contact has bounced.
isPriorityRecordBooleanIndicates whether this is a priority record.
lastUpdatedAtDateTimeTimestamp of the most recent update to the customer contact.
lastUpdatedByUserUser who last updated this customer contact.
lastViewedAtDateTimeTimestamp when this customer contact was last viewed.
leadSourceStringSource of the lead for this customer contact.
owners[User]Users who own this customer contact.
parentIdIDIdentifier of the parent record, if applicable.
preferredLanguageStringPreferred language of the customer contact.
providerExternalProviderProvider or integration that supplies this customer contact.
thirdPartyIdIDAdditional identifier used by the third-party system.
urlURLDirect URL to view the customer contact 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: