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 project in Atlassian, grouping related work and team activities. Projects provide structure for organizing goals, updates, and team collaboration within Atlassian.
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 Atlassian project.
| Field | Type | Description |
|---|---|---|
archived | Boolean | Indicates whether the project has been archived. Archived projects are no longer active but remain accessible for historical reference. |
createdAt | DateTime | The date and time when the project was originally created in Atlassian. |
descriptionMeasurement | String | A description of how the project's success will be measured or evaluated. |
descriptionWhat | String | A description explaining what the project aims to accomplish or deliver. |
descriptionWhy | String | A description explaining the reasoning, motivation, or business case behind the project. |
dueDateEndedAt | DateTime | The end of the range for the due date for when the project should end. |
dueDateStartedAt | DateTime | The start of the range for the due date for when the project should end. |
id | ID! | ID in an ARI format. An Atlassian Resource Identifier (ARI) is a globally unique identifier used across Atlassian apps and services for the unique identification of content. |
key | String | A unique short key or abbreviation for the project, typically used for quick identification and referencing. |
lastUpdatedAt | DateTime | The date and time of the most recent update or modification to the project. |
name | String | The display name of the project, providing a human-readable identifier for the project. |
owner | User | The user object representing the owner or person responsible for this project. |
privateProject | Boolean | Indicates whether the project is private and has restricted visibility to certain team members. |
startedAt | DateTime | The planned or actual start date for the project work to begin. |
state | AtlassianProjectState | The current status or state of the project (e.g., on track, at risk, done, etc.). |
url | URL | The URL link to view the project in the Atlassian web interface. |
watcherCount | Int | The number of users currently watching or following this project for updates. |
watching | Boolean | Indicates whether the current user is watching or following this project. |
| Value | Description |
|---|---|
ARCHIVED | The project has been archived and is no longer active. Archived projects are preserved for historical reference but are not actively worked on. |
AT_RISK | The project is facing significant challenges, blockers, or delays that put its success at risk. Requires attention and intervention. |
CANCELLED | The project has been permanently cancelled and will not be completed. Work has stopped and the project will not resume. |
DONE | The project has been successfully completed and all objectives have been achieved. No further work is required. |
OFF_TRACK | The project is experiencing delays, blockers, or other issues that have caused it to fall behind schedule or deviate from the planned course. |
ON_TRACK | The project is progressing as planned with no significant blockers or risks. Work is proceeding according to schedule and expectations. |
PAUSED | The project has been temporarily paused or put on hold. Work has stopped but the project is expected to resume at a later time. |
PENDING | The project has not yet started or is waiting for prerequisites, approvals, or resources before work can begin. |
The following relationships are currently supported for Atlassian project:
Relationships where Atlassian project is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian project links Atlassian project | Atlassian project | Atlassian project |
| Atlassian user contributes to Atlassian project | Atlassian project | Atlassian user Atlassian team |
| Atlassian project depends on Atlassian project | Atlassian project | Atlassian project |
| Atlassian project has Atlassian project update | Atlassian project | Atlassian project update |
| Atlassian project contributes to Atlassian goal | Atlassian project | Atlassian goal |
| Atlassian user follows Atlassian project | Atlassian project | Atlassian user |
| Jira epic tracks Atlassian project | Atlassian project | Jira work item |
| Atlassian user owns Atlassian project | Atlassian project | Atlassian user |
| Atlassian project has Atlassian home tag | Atlassian project | Atlassian Home tag |
| Jira space links entity | Atlassian project | Jira work item Confluence page Confluence blog post Compass component Loom video |
| Jira work item tracks Atlassian project | Atlassian project | Jira work item |
Rate this page: