Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jan 8, 2026

Atlassian goal update

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 an update or progress report for an Atlassian goal. Goal updates track progress, changes in status, or milestone achievements for specific goals.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

  • Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
  • Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Atlassian goal update.

FieldTypeDescription
createdAtDateTimeThe date and time when the goal update was originally created.
creatorUserThe user object representing the person who created this goal update.
editedAtDateTimeThe date and time when the goal update was last edited or modified.
idID!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.
lastEditorUserThe user object representing the person who last edited this goal update.
missedUpdateBoolean!Indicates whether this update represents a missed scheduled update that was not provided on time.
newDueDateEndedAtDateTimeThe new end of the range for the due date, if the goal's due date was updated.
newDueDateStartedAtDateTimeThe new start of the range for the due date, if the goal's due date was updated.
newScoreInt!The new score or progress value assigned to the goal in this update.
newStateGoalStateThe new state that the goal was moved to, if the state was changed.
summaryStringA text summary or description of the changes made in this goal update.
targetDateAtDateTimeThe target date for when the goal should be completed or achieved.
updateTypeUpdateTypeIndicates whether this update was created by a user or automatically by the system.
urlURLThe URL link to view the goal update in the Atlassian web interface.

Values for GoalState

ValueDescription
ARCHIVEDThe goal is archived
AT_RISKThe goal is at risk
CANCELLEDThe goal is cancelled
DONEThe goal is done
OFF_TRACKThe goal is off track
ON_TRACKThe goal is on track
PAUSEDThe goal is paused
PENDINGThe goal is pending

Values for UpdateType

ValueDescription
SYSTEMThe update was created by the system
USERThe update was created by a user

Available relationships

The following relationships are currently supported for Atlassian goal update:

Relationships where Atlassian goal update is the target object.

Relationship nameFrom object typeTo object type
Atlassian user viewed Atlassian goal updateAtlassian userAtlassian goal update
Atlassian goal has Atlassian goal updateAtlassian goalAtlassian goal update

Rate this page: