Asana: Get project portfolio settings for a portfolio
Asana projectPortfolioSettings.getProjectPortfolioSettingsForPortfolio: arguments, response, policy and SDK examples.
← Project portfolio settings operations · Get started
Operation asana.getprojectportfoliosettingsforportfolio
Provider route: GET /portfolios/{portfolio_gid}/project_portfolio_settings. 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["projectPortfolioSettings"]["getProjectPortfolioSettingsForPortfolio"]>[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.getProjectPortfolioSettingsForPortfolio(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.project_portfolio_settings.get_project_portfolio_settings_for_portfolio(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.portfolio_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.limit | integer | Optional | Minimum: 1 Maximum: 100 |
query.offset | string | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: created_at, is_access_control_inherited, offset, path, portfolio, project, uri |
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 project portfolio settings for a project — response body — data, next page data item |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand Get project portfolio settings for a project — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Get project portfolio settings for a project — response body — data, next page data item, Get project portfolio settings for a project — response body — data, next page
Schemas
Section titled “Schemas”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 project portfolio settings for a project — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A project portfolio setting represents the relationship between a project and a portfolio, including configuration such as access control inheritance. |
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 |
project | JSON | Optional | The project associated with this setting. |
project (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
project (allOf 2) | object | All variants apply | |
portfolio | JSON | Optional | The portfolio associated with this setting. |
portfolio (allOf 1) | Model | All variants apply | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact |
portfolio (allOf 2) | object | All variants apply | |
is_access_control_inherited | boolean | Optional | When 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 project portfolio settings for a project — 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 project portfolio setting — response body — data data — sdk__Project Portfolio Setting 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 project portfolio setting — response body — data data — sdk__Project Portfolio Setting Response
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 |
Search projects in a workspace — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
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 | Name 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_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_project, custom |
Get a project portfolio setting — response body — data data — sdk__Project Portfolio Setting 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 project portfolio setting represents the relationship between a project and a portfolio, including configuration such as access control inheritance. |
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 |
project | JSON | Optional | The project associated with this setting. |
project (allOf 1) | Model | All variants apply | Expand Get a rate — response body — data data parent |
project (allOf 2) | object | All variants apply | |
portfolio | JSON | Optional | The portfolio associated with this setting. |
portfolio (allOf 1) | Model | All variants apply | Expand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493 |
portfolio (allOf 2) | object | All variants apply | |
is_access_control_inherited | boolean | Optional | When true, the portfolio members gain access to the project. |
created_at | string | Optional | The 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 rate — response body — data data parent
| 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 *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. |
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 | Name 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_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_project, custom |
Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
| 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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getprojectportfoliosettingsforportfolio. Catalog operation: asana:getProjectPortfolioSettingsForPortfolio. 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"]