The Teamwork Graph API is available through Forge's Preview release phase.
Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.
To review the current limitations, see Limitations and considerations.
To share feedback or report an issue, visit the Atlassian developer community.
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 |
|---|---|---|
| JSM space links knowledge base entity | Jira space | External document Confluence space |
| Jira space explicitly links external repository | Jira space | External repository |
| Jira space has Jira board | Jira space | Jira board |
| Jira space has Jira release version | Jira space | Jira version |
| Jira space has Jira work item | Jira space | Jira work item |
| Jira space links Opsgenie team | Jira space | Opsgenie team |
| Jira space links external service | Jira space | External Service |
| Jira space related work with Jira space | Jira space | Jira space |
| Jira space shared version Jira space | Jira space | Jira space |
| Jira space unlinked external branch | Jira space | External repository |
Rate this page: