Get stories from a goal

get

https://app.asana.com/api/1.0/goals/{goal_gid}/stories

Required scope: stories:read

Returns the compact records for all stories on the goal.

Path Params

goal_gid

string

required

Globally unique identifier for the goal.

Query Params

limit

integer

1 to 100

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

offset

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.

created_after

date-time

Only return stories created after this time. Applies to every story type; pair it with resource_subtype=comment_added to get just the comments added since a given moment.
The bound is exclusive but has second granularity: it is truncated to the start of its second before filtering, so any story created within that same second is still returned. A client polling with the created_at of the last story it saw should expect to see that story again, and others alongside it, and should de-duplicate on gid.

resource_subtype

string

enum

Only return stories of this subtype. Only comment_added is supported, which narrows the response to comments and excludes activity such as assignments, due date changes, and project moves. Omit to return the full activity feed.

Allowed:

sort_ascending

boolean

Defaults to true

Creation-time order: true (the default) is oldest first, false is newest first. Pair false with limit to read only the most recent stories. Ordering is applied across the parent's stories; on a parent with an extremely large activity feed the feed may be truncated before it is ordered, so pair false with created_after to bound what is considered.

opt_fields

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. Properties can include nested fields. To learn more, see the input/output options guide.

opt_fields

opt_pretty

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.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved the specified goal's stories.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.