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

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.

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.

FieldTypeDescription
archivedBooleanIndicates whether the goal has been archived. Archived goals are no longer active but remain accessible for historical reference.
createdAtDateTimeThe date and time when the goal was originally created in Atlassian.
descriptionStringA detailed description of what the goal aims to accomplish or achieve.
dueDateEndedAtDateTimeThe end of the range for the due date when the goal should be completed.
dueDateStartedAtDateTimeThe start of the range for the due date when the goal should be completed.
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.
keyStringA unique short key or abbreviation for the goal, typically used for quick identification and referencing.
nameStringThe display name of the goal, providing a human-readable title for the objective.
ownerUserThe user object representing the owner or person responsible for this goal.
startedAtDateTimeThe planned or actual start date for when work on the goal began.
updatedAtDateTimeThe date and time of the most recent update or modification to the goal.
urlURLThe URL link to view the goal in the Atlassian web interface.
watcherCountIntThe number of users currently watching or following this goal for updates.
watchingBooleanIndicates whether the current user is watching or following this goal for updates.

Available relationships

The following relationships are currently supported for Atlassian goal:

Relationships where Atlassian goal is the source object.

Relationship nameFrom object typeTo object type
Atlassian user owns Atlassian goalAtlassian goalAtlassian user
Atlassian user contributes to Atlassian goalAtlassian goalAtlassian team
Atlassian goal has Atlassian goal updateAtlassian goalAtlassian goal update
Atlassian user follows Atlassian goalAtlassian goalAtlassian user
Atlassian goal has child Atlassian goalAtlassian goalAtlassian goal
Atlassian goal has Atlassian home tagAtlassian goalAtlassian Home tag

Rate this page: