Get multiple portfolios

get

https://app.asana.com/api/1.0/portfolios

Required scope: portfolios:read

Returns a list of the portfolios in compact representation.
The portfolios are filtered based on the following criteria:

If the request is made from a regular API user (PAT or OAuth), only portfolios owned by the current API user are returned. If the owner parameter is omitted, it defaults to the current API user. If specified, it must identify that user; use owner=me to refer to the current API user.
If the request is made from a Service Account without the owner parameter, then all portfolios across the workspace are returned.
If the request is made from a Service Account with the owner parameter, then only portfolios owned by the specified user are returned.

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

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.

workspace

string

required

The workspace or organization to filter portfolios on.

owner

string

The user who owns the portfolios. For regular API users (PAT or OAuth), defaults to the current API user when omitted and must identify that user when specified; use me to refer to the current API user. For Service Accounts, if this parameter is specified, only portfolios owned by the specified user are returned. If a Service Account omits this parameter, all portfolios across the workspace are returned.

custom_type

string

Filter results by custom type. Provide a custom type GID to return only objects of that custom type (an unknown GID returns 400). Provide an empty string to return only objects with no custom type assigned. If this parameter is omitted, results are not filtered by custom type.

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

Customizing the response

200Successfully retrieved portfolios.

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.