provider Goals GET /goals
@utdk/asana /goals
Get goals
<b>Required scope: </b><code>goals:read</code> Returns compact goal records.
opt_pretty query
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.
boolean
portfolio query
Globally unique identifier for supporting portfolio.
string
project query
Globally unique identifier for supporting project.
string
task query
Globally unique identifier for supporting task.
string
is_workspace_level query
Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.
boolean
team query
Globally unique identifier for the team.
string
workspace query
Globally unique identifier for the workspace.
string
time_periods query
Globally unique identifiers for the time periods.
array
limit query
Results per page. The number of objects to return per page. The value must be between 1 and 100.
integer
offset query
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
opt_fields query
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.
array

Try it

Authentication
Configure credentials for Asana
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getgoals
GET/goals
<b>Required scope: </b><code>goals:read</code> Returns compact goal records.

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.

Globally unique identifier for supporting portfolio.

Globally unique identifier for supporting project.

Globally unique identifier for supporting task.

Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.

Globally unique identifier for the team.

Globally unique identifier for the workspace.

Globally unique identifiers for the time periods.

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

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

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import asana from '@utdk/asana';

await asana.getgoals()