Skip to content

Asana: Get team memberships

Asana teamMemberships.getTeamMemberships: arguments, response, policy and SDK examples.

← Team memberships operations · Get started

Operation asana.getteammemberships

Provider route: GET /team_memberships. 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["teamMemberships"]["getTeamMemberships"]>[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.getTeamMemberships(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.team_memberships.get_team_memberships(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional
query.teamstringOptional
query.userstringOptional
query.workspacestringOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: is_admin, is_guest, is_limited_access, offset, path, team, team.name, uri, user, user.name

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).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Add a user to a team — response body — data data — Team Membership Compact
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand 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

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*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).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
Add a user to a team — response body — data data — Team Membership Compact
FieldTypePresenceDescription and constraints
$objectRootThis object represents a user's connection to a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get users in a team — response body — data data item
teamModelOptionalExpand Add a user to a team — response body — data data team — Team Compact
is_guestbooleanOptionalDescribes if the user is a guest in the team.
is_limited_accessbooleanOptionalDescribes if the user has limited access to the team.
Read only: true
is_adminbooleanOptionalDescribes 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
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Add a user to a team — response body — data data — sdk__Team Membership Response
next_pageModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot<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.
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 team.
Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*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
FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get an OOO entry — response body — data data user
teamModelOptionalExpand Add a user to a team — response body — data data team — shared_team_674c225d7cda
is_guestbooleanOptionalDescribes if the user is a guest in the team.
is_limited_accessbooleanOptionalDescribes if the user has limited access to the team.
Read only: true
is_adminbooleanOptionalDescribes 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
FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*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
FieldTypePresenceDescription and constraints
$objectRootA 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.
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 team.

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

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.