Asana: Remove users from a project
Asana projects.removeMembersForProject: arguments, response, policy and SDK examples.
← Projects operations · Get started
Operation asana.removemembersforproject
Provider route: POST /projects/{project_gid}/removeMembers. 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["projects"]["removeMembersForProject"]>[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.projects.removeMembersForProject(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.projects.remove_members_for_project(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.project_gid | string | Required within parent | |
query | Model | Optional | Expand Get a project — request body — query |
body | object | Required within parent | |
body.data | Model | Required within parent | Expand Remove users from a project — request body — body data |
Referenced models: Remove users from a project — request body — body data, Get a project — request body — query
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 project — response body — data data — Project Response |
$ (allOf 2) | Model | All variants apply | Expand Get a project — response body — data |
Referenced models: Get a project — response body — data data — Project Response, Get a project — response body — data
Schemas
Section titled “Schemas”34 more schemas are linked from the tables above, on the schema pages.
Remove users from a project — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
members | string | Required within parent | An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. |
Get a project — response body — data data — Project Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project — response body — data / data / default_access_level: admin, editor, commenter, viewer, default view: list, board, calendar, timeline, minimum access level for customization: admin, editor, minimum access level for sharing: admin, editor, privacy setting: public to workspace, private to team, private, resource subtype: default project, custom |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).custom_fields | array | Optional | Array of custom field values applied directly to the project itself. These represent the values set on the project, not the fields available for tasks in the project. Read only: true |
$ (allOf 2).custom_fields[] | Model | Each item | Expand Get a membership — response body — data / data / access_level: admin, editor, user parent |
$ (allOf 2).completed | boolean | Optional | True if the project is currently marked complete, false if not. Read only: true |
$ (allOf 2).completed_at | JSON | Optional | |
$ (allOf 2).completed_at (anyOf 1) | string | Alternative | The time at which this project was completed, or null if the project is not completed. Format: date-time Read only: true |
$ (allOf 2).completed_at (anyOf 2) | null | Alternative | |
$ (allOf 2).completed_by | JSON | Optional | |
$ (allOf 2).completed_by (anyOf 1) | JSON | Alternative | |
$ (allOf 2).completed_by (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).completed_by (anyOf 1) (allOf 2) | JSON | All variants apply | The user that marked this project complete, or null if the project is not completed. Read only: true |
$ (allOf 2).completed_by (anyOf 2) | null | Alternative | |
$ (allOf 2).followers | array | Optional | Array of users following this project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project. Read only: true |
$ (allOf 2).followers[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).owner | JSON | Optional | |
$ (allOf 2).owner (anyOf 1) | JSON | Alternative | The current owner of the project, may be null. |
$ (allOf 2).owner (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get users in a team — response body — data data item |
$ (allOf 2).owner (anyOf 1) (allOf 2) | object | All variants apply | |
$ (allOf 2).owner (anyOf 2) | null | Alternative | |
$ (allOf 2).team | JSON | Optional | |
$ (allOf 2).team (allOf 1) | Model | All variants apply | Expand Add a user to a team — response body — data data team — Team Compact |
$ (allOf 2).team (allOf 2) | object | All variants apply | The team that this project is shared with. |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).project_brief | JSON | Optional | |
$ (allOf 2).project_brief (anyOf 1) | JSON | Alternative | |
$ (allOf 2).project_brief (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type |
$ (allOf 2).project_brief (anyOf 1) (allOf 2) | object | All variants apply | [Opt In](/docs/inputoutput-options). The project brief associated with this project. |
$ (allOf 2).project_brief (anyOf 2) | null | Alternative | |
$ (allOf 2).created_from_template | JSON | Optional | |
$ (allOf 2).created_from_template (anyOf 1) | JSON | Alternative | |
$ (allOf 2).created_from_template (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a team's project templates — response body — data, next page data item |
$ (allOf 2).created_from_template (anyOf 1) (allOf 2) | object | All variants apply | [Opt In](/docs/inputoutput-options). The project template from which this project was created. If the project was not created from a template, this field will be null. |
$ (allOf 2).created_from_template (anyOf 2) | null | Alternative | |
$ (allOf 2).workspace | JSON | Optional | |
$ (allOf 2).workspace (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).workspace (allOf 2) | object | All variants apply | *Create-only*. The workspace or organization this project is associated with. Once created, projects cannot be moved to a different workspace. This attribute can only be specified at creation time. If the workspace for your project is an organization, you must also supply a `team` in the request body. Read only: true |
$ (allOf 2).custom_type | JSON | Optional | |
$ (allOf 2).custom_type (anyOf 1) | JSON | Alternative | |
$ (allOf 2).custom_type (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get a custom type — response body — data data asana created type identifier, gid, name, resource type |
$ (allOf 2).custom_type (anyOf 1) (allOf 2) | JSON | All variants apply | |
$ (allOf 2).custom_type (anyOf 2) | null | Alternative |
Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user parent, Get a custom type — response body — data data asana created type identifier, gid, name, resource type, Get a project — response body — data / data / default_access_level: admin, editor, commenter, viewer, default view: list, board, calendar, timeline, minimum access level for customization: admin, editor, minimum access level for sharing: admin, editor, privacy setting: public to workspace, private to team, private, resource subtype: default project, custom, Get a project brief — response body — data data gid, html text, resource type, title gid, resource type, Get a team's project templates — response body — data, next page data item, Add a user to a team — response body — data data team — Team Compact, Get users in a team — response body — data data item, Update a workspace — request body — body data
Get a project — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a project — response body — data data — sdk__Project Response |
Referenced models: Get a project — response body — data data — sdk__Project Response
Get a custom type — response body — data data asana created type identifier, gid, name, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p> Custom Types extend the types of Asana Objects. |
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 custom type. |
asana_created_type_identifier | JSON | Optional | |
asana_created_type_identifier (anyOf 1) | string | Alternative | *Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values. Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE Read only: true |
asana_created_type_identifier (anyOf 2) | null | Alternative |
Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *Project Brief* allows you to explain the what and why of the project to your team. |
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 |
Get a team's project templates — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time. |
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 | Name of the project template. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.removemembersforproject. Catalog operation: asana:removeMembersForProject. 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.