Get goal relationships

Returns compact goal relationship records.

📘

Customizing the response

Requests to this endpoint return "compact" goal relationship objects (schema) by default. To include more fields in the response, see input/output options.

Query Params
boolean

Provides “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.

integer
1 to 100

Results per page.
The number of objects to return per page. The value must be between 1 and 100.

string

Offset 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.

string
required

Globally unique identifier for the supported goal in the goal relationship.

string

If provided, filter to goal relationships with a given resource_subtype.

array of strings

This 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.

opt_fields
Responses

Response body
object
array of objects
data
object
string

Globally unique identifier of the resource, as a string.

string

The base type of this resource.

string

The 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.

subgoal supporting_work

object

The supporting resource that supports the goal. This can be either a project, task, portfolio, or goal.

number

The weight that the supporting resource's progress contributes to the supported goal's progress. This can be 0, 1, or any value in between.

object | null

Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.

string

Pagination offset for the request.

string

A relative path containing the query parameters to fetch for next_page

uri

A full uri containing the query parameters to fetch for next_page

Language
Credentials
Request
Asana Home
Asana helps you manage projects, focus on what's important, and organize work in one place for seamless collaboration.
© 2023 Asana, Inc.