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.
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["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 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.memberships.get_memberships(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.parent | string | Optional | |
query.member | string | Optional | |
query.resource_subtype | string | Optional | One of: project_membership |
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: offset, path, 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 multiple memberships — 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 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
Schemas
Section titled “Schemas”31 more schemas are linked from the tables above, on the schema pages.
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 multiple memberships — response body — data, next page data item
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a membership — response body — data data — sdk__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, Get a membership — response body — data data — sdk__Membership Response
Get a membership — response body — data / data / access_level: admin, editor, user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes a user or team's membership to a custom field including their level of access (Admin, Editor, or User). |
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 |
resource_subtype | string | Optional | Type of the membership. |
parent | Model | Optional | Expand Get a membership — response body — data / data / access_level: admin, editor, user parent The custom field the user or team is a member of. |
member | Model | Optional | Expand Get memberships from a project — response body — data, next page data item member Member can be a user or a team. |
access_level | string | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes a user or team's membership to a custom type including their level of access (Admin, Editor, User, or Viewer). |
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 |
resource_subtype | string | Optional | Type of the membership. |
parent | Model | Optional | Expand 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. |
member | Model | Optional | Expand Get memberships from a project — response body — data, next page data item member Member can be a user or a team. |
access_level | string | Optional | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand 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) | object | All variants apply | |
$ (allOf 2).is_commenter | boolean | Optional | *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_editor | boolean | Optional | *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 |
Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a membership — response body — data / data / access_level: admin, editor, viewer |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).resource_type | string | Optional | The base type of this resource. |
$ (allOf 2).resource_subtype | string | Optional | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *member* object represents either a team or user. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The type of the member (team or user) |
name | string | Optional | The name of the member |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.