Sample - Asana API
GET/goal_relationships

List goal relationships

Lists compact goal relationship records associated with a supported goal. Supply supported_goal to identify the goal, and use limit, offset, resource_subtype, and opt_fields to control pagination, filtering, and response properties.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 parameters
opt_prettybooleanoptional
Formats the response with line breaks and indentation for readability; use it primarily for debugging because it increases response size and processing time.
limitintegeroptional
Number of goal relationships to return per page. Must be between 1 and 100.
offsetstringoptional
Pagination token returned by a previous response. Omit it to retrieve the first page, and use only tokens previously returned by the API.
supported_goalstringrequired
The globally unique identifier of the supported goal whose relationships to retrieve.
resource_subtypestringoptional
Filters results to goal relationships with the specified resource subtype.
opt_fieldsarray<string>optional
Comma-separated response properties to include, including nested properties such as `supported_goal.owner.name` and `supporting_resource.resource_subtype`. Values must be selected from the documented optional properties.

6 status codes
200Returns an object containing an array of goal relationship records and, when more results are available, a `next_page` object with the next pagination offset, path, and URI.
dataarray<object>optional
next_pageobjectoptional
*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.
400Returned when `supported_goal` is missing or a parameter is malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the requested goal relationships.
errorsarray<object>optional
404Returned when the request does not identify a known action or the requested object does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the relationships from being retrieved.
errorsarray<object>optional

Error handling

A 400 is returned when supported_goal is missing or a parameter is malformed. limit must be between 1 and 100, and offset must be a token returned by a previous paginated request. A 401 is returned without valid authentication, a 403 indicates insufficient access, a 404 indicates an unknown resource or action, and a 500 indicates a server-side failure.