Remove a workspace member

POST/api/v2/workspaces/{slug}/members/remove/

Members are the people on a workspace or project, and the role each one holds.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

Body Parameters

email:requiredstring (email)

Email address.

remove_seat:optionalboolean

Whether remove seat.

Scopes

workspaces.members:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Remove a workspace member

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/members/remove/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ana@example.com",
  "remove_seat": false
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/members/remove/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "email": "ana@example.com",
        "remove_seat": False
    },
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/members/remove/", {
  method: "POST",
  headers: {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "ana@example.com",
    remove_seat: false,
  }),
});
const data = await response.json();

Response204

No response body.