Asana: Get multiple portfolios
Asana portfolios.getPortfolios: arguments, response, policy and SDK examples.
← Portfolios operations · Get started
Operation asana.getportfolios
Provider route: GET /portfolios. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["portfolios"]["getPortfolios"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.portfolios.getPortfolios(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.portfolios.get_portfolios(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.workspace | string | Required within parent | |
query.owner | string | Optional | |
query.custom_type | string | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: archived, color, created_at, created_by, created_by.name, current_status_update, current_status_update.resource_subtype, current_status_update.title, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.asana_created_field, custom_field_settings.custom_field.created_by, custom_field_settings.custom_field.created_by.name, custom_field_settings.custom_field.currency_code, custom_field_settings.custom_field.custom_label, custom_field_settings.custom_field.custom_label_position, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.default_access_level, custom_field_settings.custom_field.description, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.format, custom_field_settings.custom_field.has_notifications_enabled, custom_field_settings.custom_field.html_text_value, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.input_restrictions, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_global_to_workspace, custom_field_settings.custom_field.is_lookup_field, custom_field_settings.custom_field.is_value_read_only, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.people_value, custom_field_settings.custom_field.people_value.name, custom_field_settings.custom_field.precision, custom_field_settings.custom_field.privacy_setting, custom_field_settings.custom_field.reference_value, custom_field_settings.custom_field.reference_value.name, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.resource_subtype, custom_field_settings.custom_field.text_value, custom_field_settings.custom_field.type, custom_field_settings.is_important, custom_field_settings.parent, custom_field_settings.parent.name, custom_field_settings.parent.resource_subtype, custom_field_settings.project, custom_field_settings.project.name, custom_field_settings.project.resource_subtype, custom_fields, custom_fields.date_value, custom_fields.date_value.date, custom_fields.date_value.date_time, custom_fields.display_value, custom_fields.enabled, custom_fields.enum_options, custom_fields.enum_options.color, custom_fields.enum_options.enabled, custom_fields.enum_options.name, custom_fields.enum_value, custom_fields.enum_value.color, custom_fields.enum_value.enabled, custom_fields.enum_value.name, custom_fields.id_prefix, custom_fields.input_restrictions, custom_fields.is_formula_field, custom_fields.is_lookup_field, custom_fields.multi_enum_values, custom_fields.multi_enum_values.color, custom_fields.multi_enum_values.enabled, custom_fields.multi_enum_values.name, custom_fields.name, custom_fields.number_value, custom_fields.representation_type, custom_fields.text_value, custom_fields.type, custom_type, custom_type.asana_created_type_identifier, custom_type.name, default_access_level, due_on, members, members.name, name, offset, owner, owner.name, path, permalink_url, privacy_setting, project_templates, project_templates.name, public, resource_subtype, start_on, uri, workspace, workspace.name |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get multiple portfolios — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get a portfolio membership — response body — data data portfolio — Portfolio Compact, Get multiple portfolios — response body — data, next page
Schemas
Section titled “Schemas”12 more schemas are linked from the tables above, on the schema pages.
Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *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. |
$ (anyOf 1).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Get a portfolio membership — response body — data data portfolio — Portfolio Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *portfolio* gives a high-level overview of the status of multiple initiatives in Asana. Portfolios provide a dashboard overview of the state of multiple projects, including a progress report and the most recent [project status](/reference/project-statuses) update. Portfolios have some restrictions on size. Each portfolio has a max of 1500 items and, like projects, a max of 20 custom fields. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the portfolio. |
resource_subtype | string | Optional | 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. Known values: default_portfolio, custom |
Get multiple portfolios — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a portfolio — response body — data data — sdk__Portfolio Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a portfolio — response body — data data — sdk__Portfolio Response
Get a portfolio — response body — data data — sdk__Portfolio Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *portfolio* gives a high-level overview of the status of multiple initiatives in Asana. Portfolios provide a dashboard overview of the state of multiple projects, including a progress report and the most recent [project status](/reference/project-statuses) update. Portfolios have some restrictions on size. Each portfolio has a max of 1500 items and, like projects, a max of 20 custom fields. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the portfolio. |
resource_subtype | string | Optional | 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. Known values: default_portfolio, custom |
archived | boolean | Optional | [Opt In](/docs/inputoutput-options). True if the portfolio is archived, false if not. Archived portfolios do not show in the UI by default and may be treated differently for queries. |
color | string | Optional | Color of the portfolio. Known values: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray |
start_on | JSON | Optional | |
start_on (anyOf 1) | string | Alternative | The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` must be present in the request when setting or unsetting the `start_on` parameter. Additionally, `start_on` and `due_on` cannot be the same date.* Format: date |
start_on (anyOf 2) | null | Alternative | |
due_on | JSON | Optional | |
due_on (anyOf 1) | string | Alternative | The day on which this portfolio is due. This takes a date with format YYYY-MM-DD. Format: date |
due_on (anyOf 2) | null | Alternative | |
default_access_level | string | Optional | The default access level when inviting new members to the portfolio Known values: admin, editor, viewer |
public | boolean | Optional | Defines whether the portfolio is public to its workspace members. `true` if the portfolio is public to workspace members, `false` if it's visible only to members of the portfolio. New portfolios are private by default. |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
custom_field_settings | array | Optional | Array of custom field definitions that are enabled for the portfolio. These represent which custom fields are available to be used on items within the portfolio, but do not include any values. |
custom_field_settings[] | Model | Each item | Expand Get a goal — response body — data data custom field settings item |
current_status_update | JSON | Optional | |
current_status_update (anyOf 1) | object | Alternative | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object. The latest `status_update` posted to this portfolio. |
current_status_update (anyOf 1).gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
current_status_update (anyOf 1).resource_type | string | Optional | The base type of this resource. Read only: true |
current_status_update (anyOf 1).title | string | Optional | The title of the status update. |
current_status_update (anyOf 1).resource_subtype | string | Optional | 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. The `resource_subtype`s for `status` objects represent the type of their parent. Known values: project_status_update, portfolio_status_update, goal_status_update Read only: true |
current_status_update (anyOf 2) | null | Alternative | |
custom_fields | array | Optional | Array of custom field values applied directly to the portfolio itself. These represent the values set on the portfolio, not the fields available for items in the portfolio. |
custom_fields[] | Model | Each item | Expand Get a goal — response body — data data custom fields item |
members | array | Optional | Read only: true |
members[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
owner | Model | Optional | Expand Get an OOO entry — response body — data data user |
workspace | Model | Optional | Expand Get a portfolio — response body — data data workspace |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
privacy_setting | string | Optional | The privacy setting of the portfolio. *Note: Administrators in your organization may restrict the values of `privacy_setting`.* Known values: public_to_domain, members_only |
project_templates | array | Optional | Array of project templates that are in the portfolio Read only: true |
project_templates[] | Model | Each item | Expand Get a job by id — response body — data data new project template |
custom_type | JSON | Optional | |
custom_type (anyOf 1) | Model | Alternative | Expand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent |
custom_type (anyOf 2) | null | Alternative |
Referenced models: Get an OOO entry — response body — data data user, Get a goal — response body — data data custom fields item, Get a job by id — response body — data data new project template, Get a goal — response body — data data custom field settings item, Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent, Get a portfolio — response body — data data workspace
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getportfolios. Catalog operation: asana:getPortfolios. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["portfolios:read"]