---
title: "Preview member offboarding"
method: GET
path: "/v1/workspaces/{workspaceId}/members/{userId}/offboarding"
tags: ["Workspaces"]
---

# Preview member offboarding

`GET /v1/workspaces/{workspaceId}/members/{userId}/offboarding`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/workspaces/{workspaceId}/members/{userId}/offboarding`
- Auth: API key in header `x-api-key`

Returns a read-only plan of automatic changes and dependencies requiring manual action. A blocked preview is still returned with HTTP 200 because no changes are attempted.

## Path parameters

- `workspaceId` string, required
- `userId` string, required

## Response `200`

Read-only ready or blocked offboarding preview.

- union
  - object
    - `actions` union[], required
      - union
        - object
          - `affectedCount` integer, required
          - `code` 'PORTFOLIO_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'portfolio', required
        - object
          - `affectedCount` integer, required
          - `code` 'TEAM_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'team', required
        - object
          - `affectedCount` integer, required
          - `code` 'TEAM_MANAGER_ASSIGNMENTS_CLEARED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'team', required
        - object
          - `affectedCount` integer, required
          - `code` 'API_KEYS_DISABLED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'api_key', required
        - object
          - `affectedCount` integer, required
          - `code` 'SLACK_LINKS_DISABLED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'slack_link', required
        - object
          - `affectedCount` integer, required
          - `code` 'ACTIVE_SESSIONS_CLEARED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'session', required
        - object
          - `affectedCount` integer, required
          - `code` 'COUNTERPARTIES_UNLINKED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'counterparty', required
        - object
          - `affectedCount` integer, required
          - `code` 'INVITATIONS_CANCELED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'invitation', required
        - object
          - `affectedCount` integer, required
          - `code` 'APPROVAL_POLICY_USERS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'approval_rule', required
        - object
          - `affectedCount` integer, required
          - `code` 'WORKSPACE_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'workspace', required
        - object
          - `affectedCount` integer, required
          - `code` 'WORKSPACE_USAGE_REFRESHED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'workspace', required
    - `status` 'ready', required
  - object
    - `actions` union[], required
      - union
        - object
          - `affectedCount` integer, required
          - `code` 'PORTFOLIO_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'portfolio', required
        - object
          - `affectedCount` integer, required
          - `code` 'TEAM_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'team', required
        - object
          - `affectedCount` integer, required
          - `code` 'TEAM_MANAGER_ASSIGNMENTS_CLEARED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'team', required
        - object
          - `affectedCount` integer, required
          - `code` 'API_KEYS_DISABLED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'api_key', required
        - object
          - `affectedCount` integer, required
          - `code` 'SLACK_LINKS_DISABLED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'slack_link', required
        - object
          - `affectedCount` integer, required
          - `code` 'ACTIVE_SESSIONS_CLEARED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'session', required
        - object
          - `affectedCount` integer, required
          - `code` 'COUNTERPARTIES_UNLINKED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'counterparty', required
        - object
          - `affectedCount` integer, required
          - `code` 'INVITATIONS_CANCELED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'invitation', required
        - object
          - `affectedCount` integer, required
          - `code` 'APPROVAL_POLICY_USERS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'approval_rule', required
        - object
          - `affectedCount` integer, required
          - `code` 'WORKSPACE_MEMBERSHIPS_REMOVED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'workspace', required
        - object
          - `affectedCount` integer, required
          - `code` 'WORKSPACE_USAGE_REFRESHED', required
          - `description` string, required
          - `resources` object[], required
            - `name` string, required
            - `type` 'workspace', required
    - `blockers` union[], required
      - union
        - object
          - `code` 'LAST_WORKSPACE_OWNER', required
          - `description` string, required
          - `resolutionUrl` string, required
          - `resource` object, required
            - `name` string, required
            - `type` 'workspace', required
        - object
          - `code` 'SOLE_PORTFOLIO_OWNER', required
          - `description` string, required
          - `resolutionUrl` string, required
          - `resource` object, required
            - `name` string, required
            - `type` 'portfolio', required
        - object
          - `code` 'SPECIFIC_USER_APPROVAL_THRESHOLD', required
          - `description` string, required
          - `resolutionUrl` string, required
          - `resource` object, required
            - `name` string, required
            - `type` 'portfolio', required
        - object
          - `code` 'PERMISSION_HOLDER_APPROVAL_THRESHOLD', required
          - `description` string, required
          - `resolutionUrl` string, required
          - `resource` object, required
            - `name` string, required
            - `type` 'portfolio', required
        - object
          - `code` 'TEAM_MANAGER_APPROVAL_ROUTE', required
          - `description` string, required
          - `resolutionUrl` string, required
          - `resource` object, required
            - `name` string, required
            - `type` 'portfolio', required
    - `status` 'blocked', required

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)