Skip to main content
POST
/
api
/
organizations
/
transfer
/
scan
Scan a cross-organization user transfer for warnings and conflicts (SuperAdmin only)
curl --request POST \
  --url https://your-instance.example.com/api/organizations/transfer/scan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "5f7b1c2e8a1d4e0012c3b4a6",
  "targetOrganizationId": "5f7b1c2e8a1d4e0012c3b401",
  "reassigneeUserId": "5f7b1c2e8a1d4e0012c3b4a8"
}
'
{
  "scanVersion": "scan-2026-05-18T14:30:00Z-abc123",
  "scannedAt": "2026-05-18T14:30:00.000Z",
  "userId": "5f7b1c2e8a1d4e0012c3b4a6",
  "fromOrganizationId": "5f7b1c2e8a1d4e0012c3b400",
  "toOrganizationId": "5f7b1c2e8a1d4e0012c3b401",
  "warnings": [],
  "ownedCounts": {
    "contacts": 1240,
    "conversations": 3580,
    "assigneeConversations": 412,
    "automations": 7,
    "workflows": 3
  },
  "agentUsage": [
    {
      "agentId": "5f7b1c2e8a1d4e0012c3b610",
      "agentName": "Sales Outbound Agent",
      "total": 124,
      "autopilot": 80,
      "isDeleted": false
    }
  ],
  "reassigneeAgents": [],
  "isSourceDepartmentManager": false,
  "isSuperadmin": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
userId
string
required

User being transferred out of the source organization.

targetOrganizationId
string
required

Destination organization the user will move into.

reassigneeUserId
string
required

User in the source org who will inherit the transferring user's contacts, conversations, automations, workflows, and prompts; used to compute the scan version and surface their existing agents.

Response

Scan result returned

scanVersion
string
scannedAt
string<date-time>
userId
string
fromOrganizationId
string
toOrganizationId
string
warnings
object[]
ownedCounts
object
agentUsage
object[]
reassigneeAgents
object[]
isSourceDepartmentManager
boolean
isSuperadmin
boolean