Skip to content

Asana: Get multiple memberships

Asana memberships.getMemberships: arguments, response, policy and SDK examples.

← Memberships operations · Get started

Operation asana.getmemberships

Provider route: GET /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["memberships"]["getMemberships"]>[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.memberships.getMemberships(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.memberships.get_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.parentstringOptional
query.memberstringOptional
query.resource_subtypestringOptionalOne of: project_membership
query.limitintegerOptionalMinimum: 1
Maximum: 100
query.offsetstringOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: offset, path, uri

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 Get multiple memberships — response body — data, next page data item
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand Get multiple memberships — response body — data, next page

Referenced models: Get goals — response body — data, next page next page, Get multiple memberships — response body — data, next page data item, Get multiple memberships — response body — data, next page

31 more schemas are linked from the tables above, on the schema pages.

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
Get multiple memberships — response body — data, next page data item
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor
$ (anyOf 2)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response
$ (anyOf 3)ModelAlternativeExpand Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer
$ (anyOf 4)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user
$ (anyOf 5)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer
$ (anyOf 6)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact
$ (anyOf 7)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user, Get a membership — response body — data / data / access_level: admin, editor, user, viewer, Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor, Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact

Get multiple memberships — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a membership — response body — data data — sdk__Membership Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a membership — response body — data data — sdk__Membership Response

Get a membership — response body — data / data / access_level: admin, editor, user
FieldTypePresenceDescription and constraints
$objectRootThis object describes a user or team's membership to a custom field including their level of access (Admin, Editor, or User).
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
The custom field the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalWhether the member has admin, editor, or user access to the custom field.
Known values: admin, editor, user
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get a membership — response body — data / data / access_level: admin, editor, user parent

Get a membership — response body — data / data / access_level: admin, editor, user, viewer
FieldTypePresenceDescription and constraints
$objectRootThis object describes a user or team's membership to a custom type including their level of access (Admin, Editor, User, or Viewer).
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
The custom type the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalWhether the member has admin, editor, user, or viewer access to the custom type.
Known values: admin, editor, user, viewer
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get a custom type — response body — data data asana created type identifier, gid, name, resource type

Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor
$ (allOf 2)objectAll variants apply
$ (allOf 2).is_commenterbooleanOptional*Deprecated: new integrations should prefer the `access_level` field.* Describes if the member is comment only in goal. This field is deprecated and will always be null.
Read only: true
$ (allOf 2).is_editorbooleanOptional*Deprecated: new integrations should prefer the `access_level` field.* Describes if the member is editor in goal. This field is deprecated and will always be null.
Read only: true

Referenced models: Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor

Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: admin, editor, viewer
$ (allOf 2)objectAll variants apply
$ (allOf 2).resource_typestringOptionalThe base type of this resource.
$ (allOf 2).resource_subtypestringOptionalType of the membership.

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, viewer

Get memberships from a project — response body — data, next page data item member
FieldTypePresenceDescription and constraints
$objectRootA *member* object represents either a team or user.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe type of the member (team or user)
namestringOptionalThe name of the member

SDK function policy ID: asana.getmemberships. Catalog operation: asana:getMemberships. 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.

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.