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 goal in Atlassian's team directory and goal-tracking platform. Goals define objectives that teams or individuals work towards achieving.
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 goal.
| Field | Type | Description |
|---|---|---|
archived | Boolean | Indicates whether the goal has been archived. Archived goals are no longer active but remain accessible for historical reference. |
createdAt | DateTime | The date and time when the goal was originally created in Atlassian. |
description | String | A detailed description of what the goal aims to accomplish or achieve. |
dueDateEndedAt | DateTime | The end of the range for the due date when the goal should be completed. |
dueDateStartedAt | DateTime | The start of the range for the due date when the goal should be completed. |
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 goal, typically used for quick identification and referencing. |
name | String | The display name of the goal, providing a human-readable title for the objective. |
owner | User | The user object representing the owner or person responsible for this goal. |
startedAt | DateTime | The planned or actual start date for when work on the goal began. |
updatedAt | DateTime | The date and time of the most recent update or modification to the goal. |
url | URL | The URL link to view the goal in the Atlassian web interface. |
watcherCount | Int | The number of users currently watching or following this goal for updates. |
watching | Boolean | Indicates whether the current user is watching or following this goal for updates. |
The following relationships are currently supported for Atlassian goal:
Relationships where Atlassian goal is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Atlassian user owns Atlassian goal | Atlassian goal | Atlassian user |
| Atlassian user contributes to Atlassian goal | Atlassian goal | Atlassian team |
| Atlassian goal has Atlassian goal update | Atlassian goal | Atlassian goal update |
| Atlassian user follows Atlassian goal | Atlassian goal | Atlassian user |
| Atlassian goal has child Atlassian goal | Atlassian goal | Atlassian goal |
| Atlassian goal has Atlassian home tag | Atlassian goal | Atlassian Home tag |
Rate this page: