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.
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["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 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.workspace_memberships.get_workspace_membership(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.workspace_membership_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One 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
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 | Model | Optional | Expand Get a workspace membership — response body — data data — Workspace Membership Response |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Get a workspace membership — response body — data data — Workspace Membership Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get workspace memberships for a user — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).user_task_list | Model | Optional | Expand 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_active | boolean | Optional | Indicates 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_admin | boolean | Optional | Reflects if this user is an admin of the workspace. Read only: true |
$ (allOf 2).is_guest | boolean | Optional | Reflects if this user is a guest of the workspace. Read only: true |
$ (allOf 2).is_view_only | boolean | Optional | Reflects if this user has view only license in the workspace. Read only: true |
$ (allOf 2).vacation_dates | JSON | Optional | |
$ (allOf 2).vacation_dates (anyOf 1) | Model | Alternative | Expand Get a workspace membership — response body — data data vacation dates end on, start on |
$ (allOf 2).vacation_dates (anyOf 2) | null | Alternative | |
$ (allOf 2).created_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
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 user task list. |
owner | JSON | Optional | The owner of the user task list, i.e. the person whose My Tasks is represented by this resource. Read only: true |
owner (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
workspace | JSON | Optional | The workspace in which the user task list is located. Read only: true |
workspace (allOf 1) | Model | All variants apply | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object determines if a user is a member of a workspace. |
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 |
workspace | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | *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_on | string | Optional | *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_on | JSON | Optional | |
end_on (anyOf 1) | string | Alternative | *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) | null | Alternative |
Get a workspace membership — response body — data data — sdk__Workspace 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 determines if a user is a member of a workspace. |
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 |
workspace | Model | Optional | Expand Get a tag — response body — data data workspace |
user_task_list | object | Optional | A 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.gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
user_task_list.resource_type | string | Optional | The base type of this resource. Read only: true |
user_task_list.name | string | Optional | The name of the user task list. |
user_task_list.owner | JSON | Optional | The 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) | Model | All variants apply | Expand Get an OOO entry — response body — data data user |
user_task_list.workspace | JSON | Optional | The workspace in which the user task list is located. Read only: true |
user_task_list.workspace (allOf 1) | Model | All variants apply | Expand Get a tag — response body — data data workspace |
is_active | boolean | Optional | Indicates 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_admin | boolean | Optional | Reflects if this user is an admin of the workspace. Read only: true |
is_guest | boolean | Optional | Reflects if this user is a guest of the workspace. Read only: true |
is_view_only | boolean | Optional | Reflects if this user has view only license in the workspace. Read only: true |
vacation_dates | JSON | Optional | |
vacation_dates (anyOf 1) | Model | Alternative | Expand Get a workspace membership — response body — data data vacation dates end on, start on |
vacation_dates (anyOf 2) | null | Alternative | |
created_at | string | Optional | The 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
| 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.