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 space or workspace from an external system integrated with the Teamwork Graph. Spaces are containers that organize content, projects, or other entities within third-party platforms.
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 space.
| Field | Type | Description |
|---|---|---|
createdAt | DateTime | Timestamp when the space was created. |
createdBy | User | User who created this space. |
description | String | Description of the space. |
displayName | String | Display name of the space as shown in the source system. |
externalId | ID | Identifier of the space in the external system. |
id | ID! | Unique identifier for the space. This ID is globally unique across the entire Teamwork Graph. |
key | String | Key or short identifier for the space. |
labels | [String] | Labels associated with the space. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the space. |
lastUpdatedBy | User | User who last updated this space. |
provider | ExternalProvider | Provider or integration that supplies this space. |
spaceType | String | Type of the space (e.g., project space, team space, personal space). |
subtype | ExternalSpaceSubtype | Subtype or classification of the space. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
updateSequenceNumber | Long | Sequence number used for ordering updates. |
url | URL | Direct URL to view the space 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"). |
| Value | Description |
|---|---|
BUSINESS | Business space. |
DRIVE | Drive space. |
PROJECT | Project space. |
SERVICE_DESK | Service desk space. |
SITE | Site space. |
SOFTWARE | Software space. |
SPACE | General space. |
Rate this page: