Skip to content

Asana: Get a project portfolio setting

Asana projectPortfolioSettings.getProjectPortfolioSetting: arguments, response, policy and SDK examples.

← Project portfolio settings operations · Get started

Operation asana.getprojectportfoliosetting

Provider route: GET /project_portfolio_settings/{project_portfolio_setting_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["projectPortfolioSettings"]["getProjectPortfolioSetting"]>[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.projectPortfolioSettings.getProjectPortfolioSetting(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.project_portfolio_settings.get_project_portfolio_setting(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.project_portfolio_setting_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: created_at, is_access_control_inherited, portfolio, project

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 project portfolio setting — response body — data data — Project Portfolio Setting Response
$ (allOf 2)ModelAll variants applyExpand Get a project portfolio setting — response body — data

Referenced models: Get a project portfolio setting — response body — data data — Project Portfolio Setting Response, Get a project portfolio setting — response body — data

Get a project portfolio setting — response body — data data — Project Portfolio Setting Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get project portfolio settings for a project — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).created_atstringOptionalThe time at which this project portfolio setting was created.
Format: date-time
Read only: true

Referenced models: Get project portfolio settings for a project — response body — data, next page data item

Get a project portfolio setting — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a project portfolio setting — response body — data data — sdk__Project Portfolio Setting Response

Referenced models: Get a project portfolio setting — response body — data data — sdk__Project Portfolio Setting Response

Get project portfolio settings for a project — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA project portfolio setting represents the relationship between a project and a portfolio, including configuration such as access control inheritance.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
projectJSONOptionalThe project associated with this setting.
project (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
project (allOf 2)objectAll variants apply
portfolioJSONOptionalThe portfolio associated with this setting.
portfolio (allOf 1)ModelAll variants applyExpand Get a portfolio membership — response body — data data portfolio — Portfolio Compact
portfolio (allOf 2)objectAll variants apply
is_access_control_inheritedbooleanOptionalWhen true, the portfolio members gain access to the project.

Referenced models: Get a portfolio membership — response body — data data portfolio — Portfolio Compact, Search projects in a workspace — response body — data data item

Get a project portfolio setting — response body — data data — sdk__Project Portfolio Setting Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A project portfolio setting represents the relationship between a project and a portfolio, including configuration such as access control inheritance.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
projectJSONOptionalThe project associated with this setting.
project (allOf 1)ModelAll variants applyExpand Get a rate — response body — data data parent
project (allOf 2)objectAll variants apply
portfolioJSONOptionalThe portfolio associated with this setting.
portfolio (allOf 1)ModelAll variants applyExpand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
portfolio (allOf 2)objectAll variants apply
is_access_control_inheritedbooleanOptionalWhen true, the portfolio members gain access to the project.
created_atstringOptionalThe time at which this project portfolio setting was created.
Format: date-time
Read only: true

Referenced models: Get a rate — response body — data data parent, Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493

Get a portfolio membership — response body — data data portfolio — Portfolio Compact
FieldTypePresenceDescription and constraints
$objectRootA *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.
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 portfolio.
resource_subtypestringOptionalThe 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
Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe 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_project, custom
Get a rate — response body — data data parent
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe 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_project, custom
Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
FieldTypePresenceDescription and constraints
$objectRootA 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.
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 portfolio.
resource_subtypestringOptionalThe 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

SDK function policy ID: asana.getprojectportfoliosetting. Catalog operation: asana:getProjectPortfolioSetting. 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: ["project_portfolio_settings: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.