Asana: Get a portfolio membership
Asana portfolioMemberships.getPortfolioMembership: arguments, response, policy and SDK examples.
← Portfolio memberships operations · Get started
Operation asana.getportfoliomembership
Provider route: GET /portfolio_memberships/{portfolio_membership_gid}. 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["portfolioMemberships"]["getPortfolioMembership"]>[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.portfolioMemberships.getPortfolioMembership(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.portfolio_memberships.get_portfolio_membership(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_membership_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: access_level, portfolio, portfolio.name, portfolio.resource_subtype, user, user.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 | Model | Optional | Expand Get a portfolio membership — response body — data data — Deprecated Portfolio Membership Compact |
$ (allOf 2) | Model | All variants apply | Expand Get a portfolio membership — response body — data |
Referenced models: Get a portfolio membership — response body — data data — Deprecated Portfolio Membership Compact, Get a portfolio membership — response body — data
Schemas
Section titled “Schemas”Get a portfolio membership — response body — data data — Deprecated Portfolio Membership Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object determines if a user is a member of a portfolio. |
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 |
portfolio | Model | Optional | Expand Get a portfolio membership — response body — data data portfolio — Portfolio Compact [Opt In](/docs/inputoutput-options). The portfolio the user is a member of. |
user | Model | Optional | Expand Get users in a team — response body — data data item |
access_level | string | Optional | Whether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet. Known values: admin, editor, viewer Read only: true |
Referenced models: Get a portfolio membership — response body — data data portfolio — Portfolio Compact, Get users in a team — response body — data data item
Get a portfolio membership — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a portfolio membership — response body — data data — sdk__Deprecated Portfolio Membership Response |
Referenced models: Get a portfolio membership — response body — data data — sdk__Deprecated Portfolio Membership 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 |
Get users in a team — response body — data data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *Read-only except when same user as requester*. The user's name. |
Get a portfolio membership — response body — data data — sdk__Deprecated Portfolio Membership 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. This object determines if a user is a member of a portfolio. |
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 |
portfolio | Model | Optional | Expand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493 |
user | Model | Optional | Expand Get an OOO entry — response body — data data user |
access_level | string | Optional | Whether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet. Known values: admin, editor, viewer Read only: true |
Referenced models: Get an OOO entry — response body — data data user, Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
Get an OOO entry — response body — data data user
| 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 *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks. |
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 | *Read-only except when same user as requester*. The user's name. |
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.getportfoliomembership. Catalog operation: asana:getPortfolioMembership. 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.