Read the pending transfer of a workspace

get_workspace_transfer

Reads the ownership transfer invitation you sent for a workspace that is still waiting for its recipient.

POST /v1/get_workspace_transferScopeworkspaces:readRead only

It returns who the workspace goes to, when you sent the invitation and when it expires, the same invitation the Transfer workspace dialog shows locked. It answers null when the workspace has no open transfer invitation from you.

A workspace has at most one at a time, and it stays open for 7 days, until the recipient accepts it from the emailed link or their pending invitations, or until cancel_workspace_transfer withdraws it. The invitation link itself is never returned. See Transfer a workspace.

Request

Call it with a POST to https://api.modulify.ai/v1/get_workspace_transfer, sending the inputs below as a JSON object. The token needs the workspaces:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/get_workspace_transfer \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"WORKSPACE_ID"}'

Over MCP, the same method is the get_workspace_transfer tool.

Inputs

Input Type Required Description
workspaceId string Yes The workspace id.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.