Skip to content

Asana: Goal relationships schemas

13 Asana schemas with complete fields and constraints.

← Goal relationships operations · All schemas

Add a supporting goal relationship — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
supporting_resourcestringRequired within parentThe gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, task, or portfolio.
insert_beforestringOptionalAn id of a subgoal of this parent goal. The new subgoal will be added before the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal.
insert_afterstringOptionalAn id of a subgoal of this parent goal. The new subgoal will be added after the one specified here. `insert_before` and `insert_after` parameters cannot both be specified. Currently only supported when adding a subgoal.
contribution_weightnumberOptionalDefines how much the supporting goal’s progress contributes to the parent goal’s overall progress. When used with automatically calculated [Goal Metrics](/reference/creategoalmetric) (such as `progress_source = subgoal_progress`), this value must be greater than 0 for the subgoal to count toward the parent goal’s progress.
Accepts a number between 0 and 1 (inclusive). Defaults to `0`.

Get a goal relationship — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a goal relationship — response body — data data — sdk__Goal Relationship Response

Referenced models: Get a goal relationship — response body — data data — sdk__Goal Relationship Response

Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get goal relationships — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).supported_goalJSONOptional
$ (allOf 2).supported_goal (allOf 1)ModelAll variants applyExpand Get parent goals from a goal — response body — data data item
$ (allOf 2).supported_goal (allOf 2)objectAll variants applyThe goal that the supporting resource supports.
Read only: true

Referenced models: Get parent goals from a goal — response body — data data item, Get goal relationships — response body — data, next page data item

Get a goal relationship — response body — data data supported goal

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
The goal that the supporting resource supports.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the goal.
ownerJSONOptional
owner (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
owner (anyOf 2)nullAlternative

Referenced models: Get an OOO entry — response body — data data user

Get a goal relationship — response body — data data — Goal Relationship Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work
$ (allOf 2)objectAll variants apply

Referenced models: Get a goal relationship — response body — data / data / resource_subtype: subgoal, supporting work

Get a goal relationship — response body — data data — sdk__Goal Relationship Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *goal relationship* is an object representing the relationship between a goal and another goal, a project, a task, or a portfolio.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: subgoal, supporting_work
Read only: true
supporting_resourceobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
The supporting resource that supports the goal. This can be either a project, task, portfolio, or goal.
Read only: true
supporting_resource.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
supporting_resource.resource_typestringOptionalThe base type of this resource.
Read only: true
supporting_resource.namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
supporting_resource.resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom
contribution_weightJSONOptional
contribution_weight (anyOf 1)numberAlternativeThe weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between.
contribution_weight (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
supported_goalModelOptionalExpand Get a goal relationship — response body — data data supported goal

Referenced models: Get a goal relationship — response body — data data supported goal

Get goal relationships — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a goal relationship — response body — data data — sdk__Goal Relationship Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a goal relationship — response body — data data — sdk__Goal Relationship Response

Get goal relationships — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootA *goal relationship* is an object representing the relationship between a goal and another goal, a project, a task, or a portfolio.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: subgoal, supporting_work
Read only: true
supporting_resourceJSONOptional
supporting_resource (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
supporting_resource (allOf 2)objectAll variants applyThe supporting resource that supports the goal. This can be either a project, task, portfolio, or goal.
Read only: true
contribution_weightJSONOptional
contribution_weight (anyOf 1)numberAlternativeThe weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between.
contribution_weight (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search projects in a workspace — response body — data data item

Removes a supporting goal relationship — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
supporting_resourcestringRequired within parentThe gid of the supporting resource to remove from the parent goal. Must be the gid of a goal, project, task, or portfolio.

Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work
$ (allOf 2)objectAll variants apply
$ (allOf 2).supported_goalJSONOptional
$ (allOf 2).supported_goal (allOf 1)ModelAll variants applyExpand Get parent goals from a goal — response body — data data item
$ (allOf 2).supported_goal (allOf 2)objectAll variants applyThe goal that the supporting resource supports.
Read only: true

Referenced models: Get parent goals from a goal — response body — data data item, Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work

Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work

FieldTypePresenceDescription and constraints
$objectRootA *goal relationship* is an object representing the relationship between a goal and another goal, a project, a task, or a portfolio.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Read only: true
One of: subgoal, supporting_work
supporting_resourceJSONOptional
supporting_resource (allOf 1)ModelAll variants applyExpand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom
supporting_resource (allOf 2)objectAll variants applyThe supporting resource that supports the goal. This can be either a project, task, portfolio, or goal.
Read only: true
contribution_weightnumberOptionalThe weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between.

Referenced models: Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom

Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work resource subtype: subgoal, supporting work supporting resource resource subtype: default project, custom

FieldTypePresenceDescription and constraints
$objectRootA *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
One of: default_project, custom

Update a goal relationship — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work
$ (allOf 2)objectAll variants apply

Referenced models: Update a goal relationship — request body — body / data / resource_subtype: subgoal, supporting work

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.