Skip to content

Asana: Get a portfolio

Asana portfolios.getPortfolio: arguments, response, policy and SDK examples.

← Portfolios operations · Get started

Operation asana.getportfolio

Provider route: GET /portfolios/{portfolio_gid}. Alter supplies the connection’s credentials and routing.

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"]["getPortfolio"]>[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.getPortfolio(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_portfolio(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.portfolio_gidstringRequired within parent
queryModelOptionalExpand Get a portfolio — request body — query

Referenced models: Get a portfolio — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a portfolio — response body — data data — Portfolio Response
$ (allOf 2)ModelAll variants applyExpand Get a portfolio — response body — data

Referenced models: Get a portfolio — response body — data data — Portfolio Response, Get a portfolio — response body — data

27 more schemas are linked from the tables above, on the schema pages.

Get a portfolio — response body — data data — Portfolio Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a portfolio — response body — data / data / default_access_level: admin, editor, viewer, resource subtype: default portfolio, custom
$ (allOf 2)objectAll variants apply
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).created_byModelOptionalExpand Get users in a team — response body — data data item
$ (allOf 2).custom_field_settingsarrayOptionalArray 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.
$ (allOf 2).custom_field_settings[]ModelEach itemExpand Add a custom field to a project — response body — data data — Custom Field Setting Response
$ (allOf 2).current_status_updateJSONOptional
$ (allOf 2).current_status_update (anyOf 1)JSONAlternative
$ (allOf 2).current_status_update (anyOf 1) (allOf 1)ModelAll variants applyExpand Get status updates from an object — response body — data, next page data item
$ (allOf 2).current_status_update (anyOf 1) (allOf 2)JSONAll variants applyThe latest `status_update` posted to this portfolio.
$ (allOf 2).current_status_update (anyOf 2)nullAlternative
$ (allOf 2).custom_fieldsarrayOptionalArray 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.
$ (allOf 2).custom_fields[]ModelEach itemExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
$ (allOf 2).membersarrayOptionalRead only: true
$ (allOf 2).members[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).ownerModelOptionalExpand Get users in a team — response body — data data item
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply*Create-only*. The workspace or organization that the portfolio belongs to.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).privacy_settingstringOptionalThe privacy setting of the portfolio. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*
Known values: public_to_domain, members_only
$ (allOf 2).project_templatesarrayOptionalArray of project templates that are in the portfolio
Read only: true
$ (allOf 2).project_templates[]ModelEach itemExpand Get a team's project templates — response body — data, next page data item
$ (allOf 2).custom_typeJSONOptional
$ (allOf 2).custom_type (anyOf 1)JSONAlternative
$ (allOf 2).custom_type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
$ (allOf 2).custom_type (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).custom_type (anyOf 2)nullAlternative

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user parent, Add a custom field to a project — response body — data data — Custom Field Setting Response, Get a custom type — response body — data data asana created type identifier, gid, name, resource type, Get a portfolio — response body — data / data / default_access_level: admin, editor, viewer, resource subtype: default portfolio, custom, Get a team's project templates — response body — data, next page data item, Get status updates from an object — response body — data, next page data item, Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a portfolio — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a portfolio — response body — data data — sdk__Portfolio Response

Referenced models: Get a portfolio — response body — data data — sdk__Portfolio Response

Get a portfolio — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne 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, owner, owner.name, permalink_url, privacy_setting, project_templates, project_templates.name, public, resource_subtype, start_on, workspace, workspace.name
Get a custom type — response body — data data asana created type identifier, gid, name, resource type
FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p>

Custom Types extend the types of Asana Objects.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type.
asana_created_type_identifierJSONOptional
asana_created_type_identifier (anyOf 1)stringAlternative*Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values.
Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE
Read only: true
asana_created_type_identifier (anyOf 2)nullAlternative

SDK function policy ID: asana.getportfolio. Catalog operation: asana:getPortfolio. 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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.