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 Jira Space (formerly called Project). Spaces organize work items, define workflows, and manage team collaboration within Jira.
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 Jira space.
| Field | Type | Description |
|---|---|---|
avatar | JiraAvatar | The avatar of the space. |
description | String | The description of the space. |
id | ID! | Global identifier for the space, in the format ari:cloud:jira:{siteId}:project/{projectId}.
Note that the ID refers to a Jira Project, the previous name for this type. |
key | String! | The key of the space. |
lead | User | The space lead. |
name | String! | The name of the space. |
webUrl | URL | The browser clickable link of this space. |
| Field | Type | Description |
|---|---|---|
large | String | A large avatar (48x48 pixels). |
medium | String | A medium avatar (32x32 pixels). |
small | String | A small avatar (24x24 pixels). |
xsmall | String | An extra-small avatar (16x16 pixels). |
The following relationships are currently supported for Jira space:
Relationships where Jira space is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Jira space explicitly links external repository | Jira space | External repository |
| Jira space unlinked external branch | Jira space | External repository |
| JSM space links knowledge base entity | Jira space | External document Confluence space |
| Jira space has Jira release version | Jira space | Jira version |
| Jira space shared version Jira space | Jira space | Jira space |
| Jira space links external service | Jira space | External Service |
| Jira space related work with Jira space | Jira space | Jira space |
| Jira space links document entity | Jira space | Confluence space Confluence page External document |
| Jira space has Jira work item | Jira space | Jira work item |
| Jira space links opsgenie team | Jira space | Opsgenie team |
Rate this page: