Skip to main content
Server path: /asana-goals | Type: Application | PCID required: Yes

Tools

ToolDescription
asana_goals_add_custom_field_setting_for_goalAdd a custom field to a goal
asana_goals_add_followersAdd a collaborator to a goal
asana_goals_add_supporting_relationshipAdd a supporting goal relationship
asana_goals_create_goalCreate a goal
asana_goals_create_goal_metricCreate a goal metric
asana_goals_delete_goalDelete a goal
asana_goals_get_goalGet a goal
asana_goals_get_goal_relationshipGet a goal relationship
asana_goals_get_goal_relationshipsGet goal relationships
asana_goals_get_goalsGet goals
asana_goals_get_parent_goals_for_goalGet parent goals from a goal
asana_goals_remove_custom_field_setting_for_goalRemove a custom field from a goal
asana_goals_remove_followersRemove a collaborator from a goal
asana_goals_remove_supporting_relationshipRemoves a supporting goal relationship
asana_goals_update_goalUpdate a goal
asana_goals_update_goal_metricUpdate a goal metric
asana_goals_update_goal_relationshipUpdate a goal relationship

asana_goals_add_custom_field_setting_for_goal

Add a custom field to a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
dataobjectNoThe data value

asana_goals_add_followers

Add a collaborator to a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_goals_add_supporting_relationship

Add a supporting goal relationship Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_goals_create_goal

Create a goal Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_goals_create_goal_metric

Create a goal metric Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA generic Asana Resource, containing a globally unique identifier.

asana_goals_delete_goal

Delete a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_goals_get_goal

Get a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_goals_get_goal_relationship

Get a goal relationship Parameters:
ParameterTypeRequiredDefaultDescription
goal_relationship_gidstringYesGlobally unique identifier for the goal relationship.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_goals_get_goal_relationships

Get goal relationships Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
supported_goalstringYesGlobally unique identifier for the supported goal in the goal relationship.
resource_subtypestringNoIf provided, filter to goal relationships with a given resource_subtype.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_goals_get_goals

Get goals Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
portfoliostringNoGlobally unique identifier for supporting portfolio.
projectstringNoGlobally unique identifier for supporting project.
taskstringNoGlobally unique identifier for supporting task.
is_workspace_levelbooleanNoFilter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.
teamstringNoGlobally unique identifier for the team.
workspacestringNoGlobally unique identifier for the workspace.
time_periodsstring[]NoGlobally unique identifiers for the time periods.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_goals_get_parent_goals_for_goal

Get parent goals from a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_goals_remove_custom_field_setting_for_goal

Remove a custom field from a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
dataobjectNoThe data value

asana_goals_remove_followers

Remove a collaborator from a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_goals_remove_supporting_relationship

Removes a supporting goal relationship Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
dataobjectNoThe data value

asana_goals_update_goal

Update a goal Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_goals_update_goal_metric

Update a goal metric Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA generic Asana Resource, containing a globally unique identifier.

asana_goals_update_goal_relationship

Update a goal relationship Parameters:
ParameterTypeRequiredDefaultDescription
goal_relationship_gidstringYesGlobally unique identifier for the goal relationship.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value