Skip to content

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.

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 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.projects.remove_members_for_project(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.project_gidstringRequired within parent
queryModelOptionalExpand Get a project — request body — query
bodyobjectRequired within parent
body.dataModelRequired within parentExpand 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 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 project — response body — data data — Project Response
$ (allOf 2)ModelAll variants applyExpand Get a project — response body — data

Referenced models: Get a project — response body — data data — Project Response, Get a project — response body — data

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

Remove users from a project — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
membersstringRequired within parentAn 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand 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)objectAll variants apply
$ (allOf 2).custom_fieldsarrayOptionalArray 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[]ModelEach itemExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
$ (allOf 2).completedbooleanOptionalTrue if the project is currently marked complete, false if not.
Read only: true
$ (allOf 2).completed_atJSONOptional
$ (allOf 2).completed_at (anyOf 1)stringAlternativeThe 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)nullAlternative
$ (allOf 2).completed_byJSONOptional
$ (allOf 2).completed_by (anyOf 1)JSONAlternative
$ (allOf 2).completed_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).completed_by (anyOf 1) (allOf 2)JSONAll variants applyThe user that marked this project complete, or null if the project is not completed.
Read only: true
$ (allOf 2).completed_by (anyOf 2)nullAlternative
$ (allOf 2).followersarrayOptionalArray 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[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).ownerJSONOptional
$ (allOf 2).owner (anyOf 1)JSONAlternativeThe current owner of the project, may be null.
$ (allOf 2).owner (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).owner (anyOf 1) (allOf 2)objectAll variants apply
$ (allOf 2).owner (anyOf 2)nullAlternative
$ (allOf 2).teamJSONOptional
$ (allOf 2).team (allOf 1)ModelAll variants applyExpand Add a user to a team — response body — data data team — Team Compact
$ (allOf 2).team (allOf 2)objectAll variants applyThe team that this project is shared with.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).project_briefJSONOptional
$ (allOf 2).project_brief (anyOf 1)JSONAlternative
$ (allOf 2).project_brief (anyOf 1) (allOf 1)ModelAll variants applyExpand 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)objectAll variants apply[Opt In](/docs/inputoutput-options). The project brief associated with this project.
$ (allOf 2).project_brief (anyOf 2)nullAlternative
$ (allOf 2).created_from_templateJSONOptional
$ (allOf 2).created_from_template (anyOf 1)JSONAlternative
$ (allOf 2).created_from_template (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a team's project templates — response body — data, next page data item
$ (allOf 2).created_from_template (anyOf 1) (allOf 2)objectAll 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)nullAlternative
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll 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_typeJSONOptional
$ (allOf 2).custom_type (anyOf 1)JSONAlternative
$ (allOf 2).custom_type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
$ (allOf 2).custom_type (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).custom_type (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>custom_types:read</code></p>

Custom Types extend the types of Asana Objects.
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 custom type.
asana_created_type_identifierJSONOptional
asana_created_type_identifier (anyOf 1)stringAlternative*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)nullAlternative
Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
FieldTypePresenceDescription and constraints
$objectRootA *Project Brief* allows you to explain the what and why of the project to your team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
Get a team's project templates — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA *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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project template.

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.

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.