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 category used to classify customer organizations from an external 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 category.
| Field | Type | Description |
|---|---|---|
categoryType | String | Type or classification of this category in the source system. |
containerId | ID | Identifier of the container entity this category is scoped to, if applicable. |
createdAt | DateTime | Timestamp when the category was created. |
createdBy | User | User who created this category. |
description | String | Description of the category. |
displayName | String | Display name of the category. |
externalId | ID | Identifier of the category in the external system. |
id | ID! | Unique identifier for the customer org category. This ID is globally unique across the entire Teamwork Graph. |
key | String | Stable key for this category in the source system. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the category. |
lastUpdatedBy | User | User who last updated this category. |
owners | [User] | Users designated as owners of this category in the external system. |
parentId | ID | Identifier of the parent category or container, if applicable. |
provider | ExternalProvider | Provider or integration that supplies this category. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the category 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: