Asana: Get memberships from a team
Asana teamMemberships.getTeamMembershipsForTeam: arguments, response, policy and SDK examples.
← Team memberships operations · Get started
Operation asana.getteammembershipsforteam
Provider route: GET /teams/{team_gid}/team_memberships. 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["teamMemberships"]["getTeamMembershipsForTeam"]>[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.teamMemberships.getTeamMembershipsForTeam(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.team_memberships.get_team_memberships_for_team(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.team_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: is_admin, is_guest, is_limited_access, offset, path, team, team.name, uri, 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 | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Add a user to a team — response body — data data — Team Membership 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 team memberships — response body — data, next page |
Referenced models: Get goals — response body — data, next page next page, Add a user to a team — response body — data data — Team Membership Compact, Get team memberships — 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 |
Add a user to a team — response body — data data — Team Membership Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a user's connection to a team. |
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 |
user | Model | Optional | Expand Get users in a team — response body — data data item |
team | Model | Optional | Expand Add a user to a team — response body — data data team — Team Compact |
is_guest | boolean | Optional | Describes if the user is a guest in the team. |
is_limited_access | boolean | Optional | Describes if the user has limited access to the team. Read only: true |
is_admin | boolean | Optional | Describes if the user is a team admin. |
Referenced models: Add a user to a team — response body — data data team — Team Compact, Get users in a team — response body — data data item
Get team memberships — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Add a user to a team — response body — data data — sdk__Team Membership 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, Add a user to a team — response body — data data — sdk__Team Membership Response
Add a user to a team — response body — data data team — Team Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>teams:read</code></p> A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team. |
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 team. |
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. |
Add a user to a team — response body — data data — sdk__Team 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 represents a user's connection to a team. |
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 |
user | Model | Optional | Expand Get an OOO entry — response body — data data user |
team | Model | Optional | Expand Add a user to a team — response body — data data team — shared_team_674c225d7cda |
is_guest | boolean | Optional | Describes if the user is a guest in the team. |
is_limited_access | boolean | Optional | Describes if the user has limited access to the team. Read only: true |
is_admin | boolean | Optional | Describes if the user is a team admin. |
Referenced models: Get an OOO entry — response body — data data user, Add a user to a team — response body — data data team — shared_team_674c225d7cda
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. |
Add a user to a team — response body — data data team — shared_team_674c225d7cda
| 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 *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team. |
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 team. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.getteammembershipsforteam. Catalog operation: asana:getTeamMembershipsForTeam. 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: ["team_memberships:read"]