Skip to content
BuildBase
HTTP API menu

Remove a member from the workspace, or leave it

Needs workspace:members:remove, except to remove yourself.

DELETE/api/v1/public/workspaces/workspaceId/users/userId

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
Rate limit
Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs workspace:members:remove, except to remove yourself. The owner leaving is refused with 409 WORKSPACE_OWNER_CANNOT_LEAVE, removing the owner or the last admin with 400, and removing a member whose card pays for the subscription with 409 PAYER_STILL_PAYS.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
workspaceIdstringYes--
userIdstringYes--

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X DELETE "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/YOUR_USER_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/YOUR_USER_ID',
  {
    method: 'DELETE',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import os

import requests

response = requests.delete(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/YOUR_USER_ID",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "message": "Workspace user removed successfully",
  "userId": "000000000000000000000001",
  "workspace": {
    "_id": "000000000000000000000002",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdBy": {
      "_id": "000000000000000000000003",
      "email": "[email protected]",
      "image": "",
      "name": "Session User bound-owner"
    },
    "creditBalance": 0,
    "deleted": false,
    "features": {},
    "id": "000000000000000000000002",
    "image": "",
    "limits": {},
    "name": "Bound 1767225600000",
    "quotas": {},
    "roles": ["admin", "editor", "viewer"],
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "users": [
      {
        "_id": "000000000000000000000003",
        "email": "[email protected]",
        "image": "",
        "name": "Session User bound-owner"
      },
      {
        "_id": "000000000000000000000004",
        "email": "[email protected]",
        "image": "",
        "name": "Session User bound-viewer"
      },
      {
        "_id": "000000000000000000000005",
        "email": "[email protected]",
        "image": "",
        "name": "Ada Lovelace"
      },
      {
        "_id": "000000000000000000000006",
        "email": "[email protected]",
        "image": "",
        "name": "Existing Person"
      },
      {
        "_id": "000000000000000000000001",
        "email": "[email protected]",
        "image": "",
        "name": "Ada Lovelace"
      }
    ],
    "workflowsDisabled": false,
    "workspaceId": "hz0P6XeyVUJt3hk"
  }
}

Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

Errors

Each refusal, what it means, and what to do. The request changed nothing.

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

429 Too Many Requests

What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.

What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}

Events

A successful call can send these webhook events to the endpoints that subscribe to them: