Skip to content

Asana: Get a workspace membership

Asana workspaceMemberships.getWorkspaceMembership: arguments, response, policy and SDK examples.

← Workspace memberships operations · Get started

Operation asana.getworkspacemembership

Provider route: GET /workspace_memberships/{workspace_membership_gid}. 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["workspaceMemberships"]["getWorkspaceMembership"]>[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.workspaceMemberships.getWorkspaceMembership(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.workspace_memberships.get_workspace_membership(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.workspace_membership_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: created_at, is_active, is_admin, is_guest, is_view_only, user, user.name, user_task_list, user_task_list.name, user_task_list.owner, user_task_list.workspace, vacation_dates, vacation_dates.end_on, vacation_dates.start_on, workspace, workspace.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).dataModelOptionalExpand Get a workspace membership — response body — data data — Workspace Membership Response
$ (allOf 2)ModelAll variants applyExpand Get a workspace membership — response body — data

Referenced models: Get a workspace membership — response body — data data — Workspace Membership Response, Get a workspace membership — response body — data

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

Get a workspace membership — response body — data data — Workspace Membership Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get workspace memberships for a user — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).user_task_listModelOptionalExpand Get a user task list — response body — data data — User Task List Compact
The user's "My tasks" in the workspace.
Read only: true
$ (allOf 2).is_activebooleanOptionalIndicates whether the user is currently associated with the workspace. Returns `true` for users who have joined the workspace or have been invited but not yet accepted.
Read only: true
$ (allOf 2).is_adminbooleanOptionalReflects if this user is an admin of the workspace.
Read only: true
$ (allOf 2).is_guestbooleanOptionalReflects if this user is a guest of the workspace.
Read only: true
$ (allOf 2).is_view_onlybooleanOptionalReflects if this user has view only license in the workspace.
Read only: true
$ (allOf 2).vacation_datesJSONOptional
$ (allOf 2).vacation_dates (anyOf 1)ModelAlternativeExpand Get a workspace membership — response body — data data vacation dates end on, start on
$ (allOf 2).vacation_dates (anyOf 2)nullAlternative
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true

Referenced models: Get a user task list — response body — data data — User Task List Compact, Get workspace memberships for a user — response body — data, next page data item, Get a workspace membership — response body — data data vacation dates end on, start on

Get a workspace membership — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a workspace membership — response body — data data — sdk__Workspace Membership Response

Referenced models: Get a workspace membership — response body — data data — sdk__Workspace Membership Response

Get a user task list — response body — data data — User Task List Compact
FieldTypePresenceDescription and constraints
$objectRootA user task list represents the tasks assigned to a particular user. It provides API access to a user’s [My tasks](https://asana.com/guide/help/fundamentals/my-tasks) view in Asana.
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 user task list.
ownerJSONOptionalThe owner of the user task list, i.e. the person whose My Tasks is represented by this resource.
Read only: true
owner (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
workspaceJSONOptionalThe workspace in which the user task list is located.
Read only: true
workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data

Referenced models: Get users in a team — response body — data data item, Update a workspace — request body — body data

Get workspace memberships for a user — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootThis object determines if a user is a member of a workspace.
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
workspaceModelOptionalExpand Update a workspace — request body — body data

Referenced models: Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a workspace membership — response body — data data vacation dates end on, start on
FieldTypePresenceDescription and constraints
$objectRoot*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. Contains keys `start_on` and `end_on` for the vacation dates for the user in this workspace. If `start_on` is null, the entire `vacation_dates` object will be null. If `end_on` is before today, the entire `vacation_dates` object will be null.
Read only: true
start_onstringOptional*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. The day on which the user's vacation in this workspace starts. This is a date with `YYYY-MM-DD` format.
end_onJSONOptional
end_on (anyOf 1)stringAlternative*Deprecated:* Use the [`/ooo_entries`](/reference/getoooentries) endpoints instead. The day on which the user's vacation in this workspace ends, or null if there is no end date. This is a date with `YYYY-MM-DD` format.
end_on (anyOf 2)nullAlternative
Get a workspace membership — response body — data data — sdk__Workspace 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 determines if a user is a member of a workspace.
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
workspaceModelOptionalExpand Get a tag — response body — data data workspace
user_task_listobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A user task list represents the tasks assigned to a particular user. It provides API access to a user’s [My tasks](https://asana.com/guide/help/fundamentals/my-tasks) view in Asana.
Read only: true
user_task_list.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
user_task_list.resource_typestringOptionalThe base type of this resource.
Read only: true
user_task_list.namestringOptionalThe name of the user task list.
user_task_list.ownerJSONOptionalThe owner of the user task list, i.e. the person whose My Tasks is represented by this resource.
Read only: true
user_task_list.owner (allOf 1)ModelAll variants applyExpand Get an OOO entry — response body — data data user
user_task_list.workspaceJSONOptionalThe workspace in which the user task list is located.
Read only: true
user_task_list.workspace (allOf 1)ModelAll variants applyExpand Get a tag — response body — data data workspace
is_activebooleanOptionalIndicates whether the user is currently associated with the workspace. Returns `true` for users who have joined the workspace or have been invited but not yet accepted.
Read only: true
is_adminbooleanOptionalReflects if this user is an admin of the workspace.
Read only: true
is_guestbooleanOptionalReflects if this user is a guest of the workspace.
Read only: true
is_view_onlybooleanOptionalReflects if this user has view only license in the workspace.
Read only: true
vacation_datesJSONOptional
vacation_dates (anyOf 1)ModelAlternativeExpand Get a workspace membership — response body — data data vacation dates end on, start on
vacation_dates (anyOf 2)nullAlternative
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true

Referenced models: Get an OOO entry — response body — data data user, Get a workspace membership — response body — data data vacation dates end on, start on, Get a tag — response body — data data workspace

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.

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