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 team within an organization. Teams are collections of users that work together on projects and initiatives.
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 Team.
| Field | Type | Description |
|---|---|---|
description | String | Description of the team |
displayName | String | Display name of the team |
id | ID! | Unique identifier for the team. This ID is globally unique across the entire Teamwork Graph. |
largeAvatarImageUrl | URL | URL to the large size image of the team avatar image |
largeHeaderImageUrl | URL | URL to the large size image of the team header image |
organizationId | ID | Organization ID of the team |
profileUrl | URL | Link to the team's profile page |
smallAvatarImageUrl | URL | URL to the small size image of the team avatar image |
smallHeaderImageUrl | URL | URL to the small size image of the team header image |
The following relationships are currently supported for Team:
Relationships where Team is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian team owns Compass component | Team | Compass component |
| Atlassian team links space entity | Team | Jira space Confluence space |
Rate this page: